@tinkerer/sdk 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# @tinkerer/sdk
|
|
2
|
+
|
|
3
|
+
Typed browser clients for [tinkerer.space](https://tinkerer.space) services.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @tinkerer/sdk
|
|
9
|
+
# or
|
|
10
|
+
bun add @tinkerer/sdk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { createLmsClient } from "@tinkerer/sdk";
|
|
17
|
+
|
|
18
|
+
const lms = createLmsClient("https://api.tinkerer.space");
|
|
19
|
+
const { writing } = await lms.getDailyJapaneseWriting({});
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
One `create<Name>Client(baseUrl)` helper is exported per service
|
|
23
|
+
(`createDirectoryClient`, `createLmsClient`), plus the request/response
|
|
24
|
+
types.
|
|
25
|
+
|
|
26
|
+
ESM-only; type declarations included.
|