Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,40 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
# Dataset Card for Dataset Name
|
| 6 |
+
|
| 7 |
+
XChan + Chibiko -> Chabiko
|
| 8 |
+
|
| 9 |
+
chabiko is a XChan scraper.
|
| 10 |
+
|
| 11 |
+
## ArchiverModes
|
| 12 |
+
|
| 13 |
+
Broadly, the Archiver archives in 2 modes:
|
| 14 |
+
|
| 15 |
+
- "Archive" [The board supports archives of closed threads.]
|
| 16 |
+
- "PostStream" [The Board does not support archives. As such, fall back to Streaming as posts. (This is similar to MissingKeys.)]
|
| 17 |
+
|
| 18 |
+
|
| 19 |
+
## Supported Sites
|
| 20 |
+
|
| 21 |
+
- 4chan
|
| 22 |
+
- [TBD] Futaba Channel
|
| 23 |
+
- ???
|
| 24 |
+
|
| 25 |
+
## Formats
|
| 26 |
+
|
| 27 |
+
Both Archive modes are written to jsonl:
|
| 28 |
+
|
| 29 |
+
- For Archive mode, each json line represents an entire thread dump.
|
| 30 |
+
- For PostStream, each json represents a single post.
|
| 31 |
+
|
| 32 |
+
## Credits
|
| 33 |
+
|
| 34 |
+
Developed by KaraKaraWitch.
|
| 35 |
+
|
| 36 |
+
Music while coding: "The Space Warlord Organ Trading Simulator Official Companion Album."
|
| 37 |
+
|
| 38 |
+
## License
|
| 39 |
+
|
| 40 |
+
Apache 2.0.
|