From 1c1746a0437c607789c13b3ab56d400d5c16d727 Mon Sep 17 00:00:00 2001 From: Bryan Chen Date: Fri, 29 Dec 2023 14:03:07 +1300 Subject: [PATCH] update readme --- README.md | 40 ++++------------------------------------ 1 file changed, 4 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 5539e5f1..6983d664 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ Run node using config file npx @acala-network/chopsticks@latest -c acala ``` +## Wiki + +Documentation and tutorials are available at [wiki](https://github.com/AcalaNetwork/chopsticks/wiki). + ## Web testing Run Chopsticks in browser? Now you can turn a mainnet into a devnet and play with it directly in your browser! @@ -35,35 +39,6 @@ An example is available at [acalanetwork.github.io/chopsticks](https://acalanetw - `LOG_LEVEL`: Set log level, default is `info`. Available options: `trace`, `debug`, `info`, `warn`, `error` - `VERBOSE_LOG`: If set, do not truncating log messages -### Example configs can be found here - -- [acala](configs/acala.yml) -- [astar](configs/astar.yml) -- [basilisk](configs/basilisk.yml) -- [composable-polkadot](configs/composable-polkadot.yml) -- [hydradx](configs/hydradx.yml) -- [interlay](configs/interlay.yml) -- [karura](configs/karura.yml) -- [khala](configs/khala.yml) -- [kusama](configs/kusama.yml) -- [mandala-genesis](configs/mandala-genesis.yml) -- [mandala](configs/mandala.yml) -- [mangata](configs/mangata.yml) -- [moonbase-alpha](configs/moonbase-alpha.yml) -- [moonbeam](configs/moonbeam.yml) -- [moonriver](configs/moonriver.yml) -- [nodle-eden](configs/nodle-eden.yml) -- [phala](configs/phala.yml) -- [picasso-kusama](configs/picasso-kusama.yml) -- [picasso-rococo](configs/picasso-rococo.yml) -- [polkadot](configs/polkadot.yml) -- [rococo](configs/rococo.yml) -- [shiden](configs/shiden.yml) -- [statemine](configs/statemine.yml) -- [statemint](configs/statemint.yml) -- [tinkernet](configs/tinkernet.yml) -- [zeitgeist](configs/zeitgeist.yml) - ## Install Make sure you have setup Rust environment (>= 1.64). @@ -169,13 +144,6 @@ Chopsticks respect `http_proxy` and `https_proxy` environment variables. Export `ROARR_LOG=true` environment variable to enable log printing to stdout. To learn more, see https://www.npmjs.com/package/global-agent?activeTab=readme -## Documentation - -External documentation on Chopsticks can be found at the following links: - -- [Chopsticks types documentation](https://acalanetwork.github.io/chopsticks/docs) -- [Moonbeam documentation site](https://docs.moonbeam.network/builders/build/substrate-api/chopsticks/) - ## Plugins Chopsticks is designed to be extensible. You can write your own plugin to extend Chopsticks' functionality.