a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
docs: update various readme
+12
-12
+6
-6
README.md
+6
-6
README.md
···
16
16
<th colspan="2" align="left">Core packages</th>
17
17
</tr>
18
18
<tr>
19
-
<td><code>client</code>: the actual client library</td>
19
+
<td><code>client</code>: API client library</td>
20
20
</tr>
21
21
<tr>
22
22
<td><code>lex-cli</code>: CLI tool to generate type definitions for the API client</td>
···
46
46
<td><code>car</code>: read AT Protocol's CAR (content-addressable archive) repositories</td>
47
47
</tr>
48
48
<tr>
49
-
<td><code>cid</code>: create and parse the blessed CIDv1 format</td>
49
+
<td><code>cid</code>: CIDv1 codec</td>
50
50
</tr>
51
51
<tr>
52
-
<td><code>cbor</code>: DAG-CBOR codec that deals in AT Protocol's HTTP wire format</td>
52
+
<td><code>cbor</code>: DAG-CBOR codec</td>
53
53
</tr>
54
54
<tr>
55
-
<td><code>varint</code>: codec for Protobuf-style varint bytes</td>
55
+
<td><code>varint</code>: Protobuf-style varint codec</td>
56
56
</tr>
57
57
<tr>
58
-
<td><code>base32</code>: codec for base32</td>
58
+
<td><code>base32</code>: base32 codec</td>
59
59
</tr>
60
60
<tr>
61
61
<th colspan="2" align="left">Bluesky-related packages</th>
62
62
</tr>
63
63
<tr>
64
-
<td><code>bluesky-richtext-builder</code>: builder for Bluesky's rich text format</td>
64
+
<td><code>bluesky-richtext-builder</code>: builder pattern for Bluesky's rich text format</td>
65
65
</tr>
66
66
<tr>
67
67
<td><code>bluesky-threading</code>: create Bluesky threads containing multiple posts with one write</td>
+1
-1
packages/core/client/README.md
+1
-1
packages/core/client/README.md
···
5
5
- **small**, the bare minimum is ~1 kB gzipped with the full package at ~2.4 kB gzipped.
6
6
- **no validations**, type definitions match actual HTTP responses.
7
7
8
-
the api client only ships with base AT Protocol lexicons and endpoints, along with an
8
+
the API client only ships with base AT Protocol lexicons and endpoints, along with an
9
9
authentication middleware for signing in to a PDS. for manipulating Bluesky records and making
10
10
requests to it, see the `@atcute/bluesky` package.
11
11
+1
-1
packages/utilities/base32/README.md
+1
-1
packages/utilities/base32/README.md
+2
-2
packages/utilities/cbor/README.md
+2
-2
packages/utilities/cbor/README.md
···
1
1
# @atcute/cbor
2
2
3
-
DAG-CBOR codec that deals in AT Protocol's HTTP wire format.
3
+
DAG-CBOR codec library, focused on dealing with AT Protocol's HTTP wire format.
4
4
5
-
- Only JSON types are recognized and nothing else (sorta), this means:
5
+
- Only JSON types are recognized and almost nothing else, this means:
6
6
- No `Map` objects, it will always be plain objects with string keys
7
7
- No `undefined` values, it will be skipped or will throw an error
8
8
- No tagged value support other than CID, which gets converted to a cid-link interface
+1
-1
packages/utilities/cid/README.md
+1
-1
packages/utilities/cid/README.md