e97a068bf0
* set up development process for docs * set up development process for docs * Add local installs for Typedoc on gitignore * Add Typedoc comments on types.ts file * add typedoc config file * update types and add annotations * Add updates on types file * add examples + manage sort order for doc items * update client methods with examples * add description of NymMixnetClientOptions * add description of NymMixnetClientOptions * fix linting --------- Co-authored-by: Lorexia <alexia.lorenza.martinel@protonmail.com>
Nym SDK (Typescript)
Packages
- SDK - the Nym SDK package
Examples
- Plain HTML + Javascript - very simple chat app written in plain Javascript
- Chat App - simple chat app written in React with Webpack
Coming soon:
- Node tester - a React app that sends test packets to a mixnode and measure the network speed
- Mixnet topology viewer - a Svelte app that shows the mixnodes current in the active set
- Get a bandwidth voucher - get a bandwidth voucher to use the mixnet