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

Commit

Permalink
prepare for 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
williamhorning committed Aug 13, 2024
1 parent 45a41df commit 6ded2eb
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Project logo](/banner.png)
![Project logo](https://raw.githubusercontent.com/meower-media-co/api-client/main/banner.png)

# api-client

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

- @meower/api-client on jsr
- esm.sh/jsr/@meower/api-client in browsers

## example

see the [docs](https://docs.meower.org/api-client/) for more

```ts
import { socket } from '@meower/api-client';

const events = await socket.login({
api_url: 'https://api.meower.org',
api_token: 'your.token.here',
socket_url: 'wss://server.meower.org',
});

events.on('auth', ({ username }) => {
console.log(`logged in as ${username}`);
});
```
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@meower/api-client",
"version": "1.0.0-rc.6",
"version": "1.0.0",
"exports": "./src/index.ts",
"fmt": {
"lineWidth": 80,
Expand Down

0 comments on commit 6ded2eb

Please sign in to comment.