diff --git a/README.md b/README.md index 2774e66..c53ce12 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![GitHub issues](https://img.shields.io/github/issues-raw/LemmyNet/lemmy-js-client.svg)](https://github.com/LemmyNet/lemmy-js-client/issues) [![License](https://img.shields.io/github/license/LemmyNet/lemmy-js-client.svg)](LICENSE) ![GitHub stars](https://img.shields.io/github/stars/LemmyNet/lemmy-js-client?style=social) + # lemmy-js-client @@ -21,14 +22,14 @@ A javascript / typescript http and websocket client and type system for [Lemmy]( [LemmyWebsocket docs](https://join-lemmy.org/api/classes/LemmyWebsocket.html) ```ts -import { Login, LemmyWebsocket } from 'lemmy-js-client'; +import { Login, LemmyWebsocket } from "lemmy-js-client"; let client: LemmyWebsocket = new LemmyWebsocket(); -let form = new Login({ +let form: Login = { username_or_email: "my_email@email.tld", password: "my_pass", -}); +}; this.ws.send(client.login(form)); ``` @@ -44,3 +45,21 @@ let baseUrl = 'https://lemmy.ml'; let client: LemmyHttp = new LemmyHttp(baseUrl, headers?); let jwt = await client.httpLogin(loginForm).jwt; ``` + +## Development + +You can use [yalc](https://github.com/wclr/yalc) to develop and test changes locally: + +``` +yarn global add yalc + +# Go to lemmy-js-client dir +yalc publish --push + +# Go to your client dir +yalc add lemmy-js-client + +# To do updates, go back to the lemmy-js-client dir +# This also updates it, in every dir you've added it. +yalc publish --push +```