Update README.md

README.md

@@ -1,3 +1,48 @@
----
-license: wtfpl
----
+---
+license: wtfpl
+---
+# Bluesky Aozora Dive
+
+... Is an archive of atproto's firehose (and relatedly bluesky) streams.
+
+[Repo currently up for marking reasons.]
+
+## Data Formats
+
+We present data as is with minimum enrichment.
+
+- Likes authors are enriched with their author and usernames. The post themselves are not enriched since that will incur additional requests which can be quite heavy.
+- Any cryptographic CIDs are stripped as they do not possess any useful textual data.
+
+Usernames are constructed in the following format:
+```json
+{
+    "did": "did:plc:5pg23j2334q5gcidzk6ps57c",
+    "uns": "phietje.bsky.social"
+}
+```
+
+do note that usernames may be a list of usernames if the `did` user has morethan 1 username.
+
+## Various Notes
+
+### Terms
+
+`did` -> `Decentralized ID`. Consider this as `ID` for most cases and it points to a unique ID.  
+`uns` -> `Usernames`. Either can be a single string or a list of usernames. Do not blindly assume this is going to be only a string!
+
+### Recommendations
+
+For getting a more proper stream of posts, it's recommended to keep a track of users + posts in a index cache.
+
+Then again, you can just fetch a list from bsky api directly lol.
+
+Do consider reading up on bsky docs and atproto docs.
+
+### Deletions
+
+UnActions ("unpost","unlike","unrepost") only contains `rid` as the record key.
+
+### License
+
+For everyone out there, data is meant to be free unlike some previous license I did. This is free for grabs aka `wtfpl` if anyone wants to know.