Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Commit 6ded2eb

Browse files
prepare for 1.0.0
1 parent 45a41df commit 6ded2eb

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Project logo](/banner.png)
1+
![Project logo](https://raw.githubusercontent.com/meower-media-co/api-client/main/banner.png)
22

33
# api-client
44

@@ -10,3 +10,21 @@ get the package from your favorite source of packages:
1010

1111
- @meower/api-client on jsr
1212
- esm.sh/jsr/@meower/api-client in browsers
13+
14+
## example
15+
16+
see the [docs](https://docs.meower.org/api-client/) for more
17+
18+
```ts
19+
import { socket } from '@meower/api-client';
20+
21+
const events = await socket.login({
22+
api_url: 'https://api.meower.org',
23+
api_token: 'your.token.here',
24+
socket_url: 'wss://server.meower.org',
25+
});
26+
27+
events.on('auth', ({ username }) => {
28+
console.log(`logged in as ${username}`);
29+
});
30+
```

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@meower/api-client",
3-
"version": "1.0.0-rc.6",
3+
"version": "1.0.0",
44
"exports": "./src/index.ts",
55
"fmt": {
66
"lineWidth": 80,

0 commit comments

Comments
 (0)