diff --git a/README.md b/README.md index 0c80f08..6a99e94 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Project logo](/banner.png) +![Project logo](https://raw.githubusercontent.com/meower-media-co/api-client/main/banner.png) # api-client @@ -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}`); +}); +``` diff --git a/deno.json b/deno.json index d7f3554..f271466 100644 --- a/deno.json +++ b/deno.json @@ -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,