Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-20 15:26:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix docs

Browse Source
This commit is contained in:
Franz Heinzmann (Frando)
2022-06-30 00:34:49 +02:00
committed by Simon Laux
parent 2df10857ca
commit aaf27e4434
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
deltachat-jsonrpc/README.md
View File

@@ -69,13 +69,11 @@ npm run docs
``` ```
Then open the [`typescript/docs`](typescript/docs) folder in a web browser. Then open the [`typescript/docs`](typescript/docs) folder in a web browser.
##### Usage in JavaScript projects ## Development
It is not yet straightforward to use the client this way in a JavaScript project. If you have a need please open an issue. For now, clone this repo, run `npm run build` in the typescript folder and copy `dist/deltachat.bundle.js` into your project. This will be obsolete once we publish the client to NPM (likely soon).
#### Running the example app #### Running the example app
We include a small demo web application that talks to the WebSocket server. We include a small demo web application that talks to the WebSocket server. It can be used for testing. Feel invited to expand this.
```sh ```sh
cd typescript cd typescript
@@ -83,13 +81,13 @@ npm run build
npm run example:build npm run example:build
npm run example:start npm run example:start
``` ```
Then, open [`http://localhost:8080`](http://localhost:8080) in a web browser. Then, open [`http://localhost:8080/example.html`](http://localhost:8080/example.html) in a web browser.
## Development Run `npm run example:dev` to live-rebuild the example app when files changes.
### Testing ### Testing
The crate includes both (basic) Rust tests and integration tests that use the TypeScript client. The crate includes both a basic Rust smoke test and more featureful integration tests that use the TypeScript client.
#### Rust tests #### Rust tests