diff --git a/readme.md b/readme.md index 7ef7352..03a3d43 100644 --- a/readme.md +++ b/readme.md @@ -1,20 +1,19 @@ # Installation ``` -git clone https://git.harvmaster.com/Harvmaster/sync-server-example.git -cd sync-server-example +git clone hgit@gitlab.com:GeneralProtocols/xo/sync-client.git +cd sync-client npm ci ``` # Running -There are 2 examples in the `src/index.ts` file. +There are 2 examples in the `demo` folder. -- `testSSE()` - Example using the SSE client -- `testWS()` - Example using the WebSocket client +- The `suite` will run general read/write operations on various clients. +- The `tui` will allow you to write values into the console as well as monitor for updates. + +- `npx tsx ./demo/suite.ts` - Optionally, add `sse` | `ws` | `encryped` | `encryptedPerResource` to select a specific implementation to test. Defaults to all clients. +- `npx tsx ./demo/tui.ts` - Optionally add `false` to use a SSE without encryption. Default is `EncryptedClientPerResource` -To run the examples, you can use the following command: -``` -npm run start -```