Feliday/Feliday-js-client
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Adding development instructions. Fixes #101 (#102)

Browse source
This commit is contained in:
Dessalines 2023-01-04 12:05:41 -05:00 committed by GitHub
parent e844f95acf
commit b685a3480b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -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) [![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) [![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) ![GitHub stars](https://img.shields.io/github/stars/LemmyNet/lemmy-js-client?style=social)
</div> </div>
# lemmy-js-client # 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) [LemmyWebsocket docs](https://join-lemmy.org/api/classes/LemmyWebsocket.html)
```ts ```ts
import { Login, LemmyWebsocket } from 'lemmy-js-client'; import { Login, LemmyWebsocket } from "lemmy-js-client";
let client: LemmyWebsocket = new LemmyWebsocket(); let client: LemmyWebsocket = new LemmyWebsocket();
let form = new Login({ let form: Login = {
username_or_email: "my_email@email.tld", username_or_email: "my_email@email.tld",
password: "my_pass", password: "my_pass",
}); };
this.ws.send(client.login(form)); this.ws.send(client.login(form));
``` ```
@ -44,3 +45,21 @@ let baseUrl = 'https://lemmy.ml';
let client: LemmyHttp = new LemmyHttp(baseUrl, headers?); let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
let jwt = await client.httpLogin(loginForm).jwt; 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
```