aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2025-02-10 00:29:18 -0800
committerFuwn <[email protected]>2025-02-10 00:33:12 -0800
commitfcf7df7f77a080eea28774f29b8198e647015393 (patch)
treea358f84e9bcd72d9addf1a5fe9cfa98e4533b9ea /README.md
downloadhololist-to-json-and-ical-fcf7df7f77a080eea28774f29b8198e647015393.tar.xz
hololist-to-json-and-ical-fcf7df7f77a080eea28774f29b8198e647015393.zip
feat: initial release
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83c3917
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# 🥟 HoloList to JSON
+
+> Dump hololive & HOLOSTARS Birthdays from [HoloList](https://hololist.net) to JSON
+
+## Latest Data
+
+A JSON file containing the *latest* HoloList data is present in the [`latest.json`](https://raw.githubusercontent.com/Fuwn/hololist-to-json/refs/heads/main/latest.json)
+file.
+
+## Sample Data
+
+```json
+[
+ {
+ "month": 1,
+ "day": 12,
+ "name": "Usada Pekora",
+ "pictureURL": "https://hololist.net/wp-content/uploads/2022/02/usada-pekora-portrait-66-300x300.jpg",
+ "profileURL": "https://hololist.net/usada-pekora/"
+ },
+ {
+ "month": 12,
+ "day": 12,
+ "name": "Kobo Kanaeru",
+ "pictureURL": "https://hololist.net/wp-content/uploads/2022/03/kobo-kanaeru-portrait-66-300x300.jpg",
+ "profileURL": "https://hololist.net/kobo-kanaeru/"
+ }
+]
+```
+
+## License
+
+This project is licensed under the terms of the [GNU General Public License v3.0 license](./LICENSE.txt).