before dangerous ops
Signed-off-by: T-Hax <>
This commit is contained in:
parent
4065d89909
commit
704648ed2c
41 changed files with 31021 additions and 460 deletions
12
docs/ABOUT.md
Normal file
12
docs/ABOUT.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
# Tornado Cash SDK
|
||||
|
||||
A collection of Typescript packages which enable you to easily use the Tornado Cash protocol.
|
||||
|
||||
* [Installation](./INSTALLATION.md)
|
||||
* [Usage](./USAGE.md)
|
||||
|
||||
### Package list and short descriptions
|
||||
|
||||
* **@tornado/sdk** - this package bundles all of the below packages into one, which can then be imported into a project. It does not provide a default import, instead you may alias it as wished.
|
||||
|
||||
* **@tornado/sdk-core** - this package provides `Core` which bundles the main Tornado Cash Classic logic into one class. In short, you can build deposit & withdrawal transactions, synchronize deposit and event caches more easily, listen to new deposit or withdrawal events
|
19
docs/INSTALLATION.md
Normal file
19
docs/INSTALLATION.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Installation
|
||||
|
||||
## Configuring Gitea
|
||||
|
||||
In order to use any of the packages, you have configure `npm` / `yarn` / `pnpm` to work with Gitea.
|
||||
|
||||
The [official guide is here](https://development.tornadocash.community/T-Hax/gitea-guide), you can also download it by doing:
|
||||
|
||||
```bash
|
||||
git clone https://development.tornadocash.community/T-Hax/gitea-guide
|
||||
```
|
||||
|
||||
If you want to skip doing the entire configuration, you can just add to your `.npmrc` (if using `npm`), the following, albeit this is limited and untested, but should work for `npm`:
|
||||
|
||||
```yaml
|
||||
@tornado:registry=https://development.tornadocash.community/api/packages/T-Hax/npm/
|
||||
```
|
||||
|
||||
## Installing the packages
|
1
docs/USAGE.md
Normal file
1
docs/USAGE.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Usage
|
Loading…
Add table
Add a link
Reference in a new issue