KaraKaraWitch commited on
Commit
1c2309c
1 Parent(s): 63a4670

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -8
README.md CHANGED
@@ -34,7 +34,6 @@ The most basic root construct will typically contain:
34
  "typ": "<Type>",
35
  "usr": {
36
  "did": "did:plc:ssd5xwqvrdrxyu2br7sfjwzy",
37
- "nms": "samera1989.bsky.social"
38
  },
39
  }
40
  ```
@@ -44,14 +43,14 @@ Usernames are constructed in the following format:
44
  ```json
45
  {
46
  "did": "did:plc:4hqjfn7m6n5hno3doamuhgef",
47
- "nms": "yui.syui.ai"
48
  }
49
  ```
50
 
51
  `did`: `Decentralized ID`. Consider this as `ID` for most cases and it points to a unique ID.
52
- `uns`: `Usernames`. Either can be a string or a list of strings. Do not blindly assume this is going to be only a string! Though generally, it should just be a string.
 
53
 
54
- For most cases, expect these 2 fields to describe a user.
55
 
56
  ### Blobs
57
 
@@ -71,7 +70,6 @@ Given the user account is this:
71
  "typ": "account",
72
  "usr": {
73
  "did": "did:plc:lri5xcv6ogaldxkigm32wa57",
74
- "nms": "yukichiroyuchi.bsky.social",
75
  "avy": {
76
  "mime": "image/jpeg",
77
  "size": 226086,
@@ -102,7 +100,6 @@ Posts can get rather complicated. Here's a sample of a simple post.
102
  "typ": "post",
103
  "usr": {
104
  "did": "did:plc:ssd5xwqvrdrxyu2br7sfjwzy",
105
- "nms": "samera1989.bsky.social"
106
  },
107
  "rid": "3kzyon77od52v",
108
  "chg": "create",
@@ -193,7 +190,6 @@ As for replies and other fields, here's a more complex example.
193
  "typ": "account",
194
  "usr": {
195
  "did": "did:plc:cj3ngde5wbljf5sh33g7zsdz",
196
- "nms": "shirotsu.bsky.social",
197
  "avy": {
198
  "mime": "image/jpeg",
199
  "size": 79776,
@@ -211,7 +207,7 @@ As for replies and other fields, here's a more complex example.
211
  }
212
  ```
213
 
214
- For Accounts, the `usr` field is more filled. In addition to `did` and `nms`, there are other fields like:
215
 
216
  - `avy`/`bnr`: either a `Blob` or null. Refer to [Blobs](#blobs) section above.
217
  - `crt`: Account Creation time. Can be null!
@@ -271,6 +267,12 @@ In other words, we also capture content that failed to follow specs. Like this:
271
 
272
  Lines marked as `IllegalSpecFollowerAkaFixYourShit` should be ignored in general though. Content isn't great anyway.
273
 
 
 
 
 
 
 
274
  ## Various Notes
275
 
276
  ### Recommendations
 
34
  "typ": "<Type>",
35
  "usr": {
36
  "did": "did:plc:ssd5xwqvrdrxyu2br7sfjwzy",
 
37
  },
38
  }
39
  ```
 
43
  ```json
44
  {
45
  "did": "did:plc:4hqjfn7m6n5hno3doamuhgef",
 
46
  }
47
  ```
48
 
49
  `did`: `Decentralized ID`. Consider this as `ID` for most cases and it points to a unique ID.
50
+ `nms`: **[DEPRECATED!]** `Usernames`. Either can be a string or a list of strings. Do not blindly assume this is going to be only a string! Though generally, it should just be a string.
51
+ - **`nms`** will not be provided in future firehose archives. Turns out PLC directory didn't like me.
52
 
53
+ For most cases, expect the did to describe a user.
54
 
55
  ### Blobs
56
 
 
70
  "typ": "account",
71
  "usr": {
72
  "did": "did:plc:lri5xcv6ogaldxkigm32wa57",
 
73
  "avy": {
74
  "mime": "image/jpeg",
75
  "size": 226086,
 
100
  "typ": "post",
101
  "usr": {
102
  "did": "did:plc:ssd5xwqvrdrxyu2br7sfjwzy",
 
103
  },
104
  "rid": "3kzyon77od52v",
105
  "chg": "create",
 
190
  "typ": "account",
191
  "usr": {
192
  "did": "did:plc:cj3ngde5wbljf5sh33g7zsdz",
 
193
  "avy": {
194
  "mime": "image/jpeg",
195
  "size": 79776,
 
207
  }
208
  ```
209
 
210
+ For Accounts, the `usr` field is more filled. In addition to `did`, there are other fields like:
211
 
212
  - `avy`/`bnr`: either a `Blob` or null. Refer to [Blobs](#blobs) section above.
213
  - `crt`: Account Creation time. Can be null!
 
267
 
268
  Lines marked as `IllegalSpecFollowerAkaFixYourShit` should be ignored in general though. Content isn't great anyway.
269
 
270
+ ## Changes
271
+
272
+ **[01/09/24]**
273
+
274
+ Removed mentions of `nms`. We stopped resolving DIDs after 01/09/24 as it appears that I'm slamming PLC directory too much lol. Sorry!
275
+
276
  ## Various Notes
277
 
278
  ### Recommendations