From 674511ff8605100e319eff669f34ee6b04b3451e Mon Sep 17 00:00:00 2001 From: woodser Date: Wed, 3 Jul 2024 12:14:00 -0400 Subject: [PATCH] move documentation section above using in your project --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index d01adeab9..7ddec638d 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,23 @@ assert(fundsReceived); await walletFull.close(true); ``` +## Documentation + +* [TypeDocs](https://woodser.github.io/monero-ts/typedocs/) +* [API and model overview with visual diagrams](https://woodser.github.io/monero-java/monero-spec.pdf) +* [Creating wallets](docs/developer_guide/creating_wallets.md) +* [The data model: blocks, transactions, transfers, and outputs](docs/developer_guide/data_model.md) +* [Getting transactions, transfers, and outputs](docs/developer_guide/query_data_model.md) +* [Sending funds](docs/developer_guide/sending_funds.md) +* [Multisig wallets](docs/developer_guide/multisig_wallets.md) +* [View-only and offline wallets](docs/developer_guide/view_only_offline.md) +* [Connection manager](docs/developer_guide/connection_manager.md) +* [HTTPS and self-signed certificates](./docs/developer_guide/https_and_self_signed_certificates.md) +* [Mocha tests](src/test) +* [Installing prerequisites](docs/developer_guide/installing_prerequisites.md) +* [Getting started part 1: creating a Node.js application](docs/developer_guide/getting_started_p1.md) +* [Getting started part 2: creating a web application](docs/developer_guide/getting_started_p2.md) + ## Using monero-ts in your project 1. `cd your_project` or `mkdir your_project && cd your_project && npm init` @@ -117,23 +134,6 @@ To avoid the error "Failed to parse URL from /path/to/file.wasm" on Node.js >16: 2. Start monerod, e.g.: `./monerod --stagenet` (or use a remote daemon). 3. Start monero-wallet-rpc, e.g.: `./monero-wallet-rpc --daemon-address http://localhost:38081 --stagenet --rpc-bind-port 38084 --rpc-login rpc_user:abc123 --wallet-dir ./` -## Documentation - -* [TypeDocs](https://woodser.github.io/monero-ts/typedocs/) -* [API and model overview with visual diagrams](https://woodser.github.io/monero-java/monero-spec.pdf) -* [Creating wallets](docs/developer_guide/creating_wallets.md) -* [The data model: blocks, transactions, transfers, and outputs](docs/developer_guide/data_model.md) -* [Getting transactions, transfers, and outputs](docs/developer_guide/query_data_model.md) -* [Sending funds](docs/developer_guide/sending_funds.md) -* [Multisig wallets](docs/developer_guide/multisig_wallets.md) -* [View-only and offline wallets](docs/developer_guide/view_only_offline.md) -* [Connection manager](docs/developer_guide/connection_manager.md) -* [HTTPS and self-signed certificates](./docs/developer_guide/https_and_self_signed_certificates.md) -* [Mocha tests](src/test) -* [Installing prerequisites](docs/developer_guide/installing_prerequisites.md) -* [Getting started part 1: creating a Node.js application](docs/developer_guide/getting_started_p1.md) -* [Getting started part 2: creating a web application](docs/developer_guide/getting_started_p2.md) - ## Building WebAssembly binaries from source This project uses WebAssembly to package and execute Monero's source code for a browser or other WebAssembly-supported environment.