diff --git a/README.md b/README.md index 59a85cd3..19556415 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ ![Cute Panopticon](./docs/watchers-graphic.png) -Watchers make managing data in Dapp development as frictionless as possible. They do this by querying, transforming, and caching Ethereum state data cheaper and faster compared to existing solutions. This data also comes with evidence for generating cryptographic proofs to provide verification that the data is authentic. Public watchers are found in the [packages](./packages) directory. +Watchers make managing data in Dapp development as frictionless as possible. They do this by querying, transforming, and caching Ethereum state data cheaper and faster compared to existing solutions. This data also comes with evidence for generating cryptographic proofs to provide verification that the data is authentic. Public watchers are found in the [packages](/packages) directory. -Go [here](https://github.com/cerc-io/stack-orchestrator/tree/main/stacks/erc20) for a quick start demo of setting up the stack and deploying/using the erc20 watcher via the Laconic Stack Orchestrator. +Go [here](https://github.com/cerc-io/stack-orchestrator/tree/main/app/data/stacks/erc20) for a quick start demo of setting up the stack and deploying/using the erc20 watcher via the Laconic Stack Orchestrator. ## Prerequisites @@ -20,7 +20,7 @@ The Laconic Stack Orchestrator provides all the tools to quickly get started wit - `yarn` [Install](https://yarnpkg.com/getting-started/install) - `postgres` [Install](https://www.postgresql.org/download/) -You'll need the above if you plan on digging into this repo and/or writing your own watchers. +You'll need the above if you plan on digging into this repo, writing your own watchers, or experimenting with watchers not currentlysupported by Stack Orchestrator. ## Services @@ -30,7 +30,7 @@ The default configuration files used by watchers assume the following services a * [cerc-io/ipld-eth-server](https://github.com/cerc-io/ipld-eth-server) with native GQL API enabled, on port 8082 * [cerc-io/ipld-eth-db](https://github.com/cerc-io/ipld-eth-db) to populate the postgres database for `ipld-eth-server` -These services are dockerized by the Laconic Stack Orchestrator (`laconic-so`). [Use it](https://github.com/cerc-io/stack-orchestrator) unless you plan on digging into those codebases. +These services are dockerized by the Laconic Stack Orchestrator (`laconic-so`). [Use it](https://github.com/cerc-io/stack-orchestrator) unless you plan on digging into those codebases. For more information on setting up these services up by hand, see [here](/docs/README.md) ## Setup @@ -40,7 +40,8 @@ From the root of this repository, run: to download dependencies and build all the watchers. -Each watcher has a README with instruction on building and using it. See the [packages](./packages) directory for all available watchers. +Orient yourself with the available CLI commands [here](docs/cli.md) and in some cases, watchers have in-depth demos (e.g. [mobymask](/packages/mobymask-watcher)) + [//]: # (TODO: ## Generating Watchers) diff --git a/packages/erc20-watcher/README.md b/packages/erc20-watcher/README.md index a31fb83d..309006b6 100644 --- a/packages/erc20-watcher/README.md +++ b/packages/erc20-watcher/README.md @@ -1,6 +1,6 @@ # ERC20 Watcher -First try the [stack orchestrator](https://github.com/cerc-io/stack-orchestrator) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. +First try the [erc20 demo in stack orchestrator](https://github.com/cerc-io/stack-orchestrator/tree/main/app/data/stacks/erc20) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. ## Build diff --git a/packages/erc721-watcher/README.md b/packages/erc721-watcher/README.md index 5cec9dc1..797a55e0 100644 --- a/packages/erc721-watcher/README.md +++ b/packages/erc721-watcher/README.md @@ -1,6 +1,6 @@ # erc721-watcher -First try the [stack orchestrator](https://github.com/cerc-io/stack-orchestrator) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. +First try the [erc721 demo in stack orchestrator](https://github.com/cerc-io/stack-orchestrator/tree/main/app/data/stacks/erc721) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. ## Setup diff --git a/packages/mobymask-watcher/README.md b/packages/mobymask-watcher/README.md index dd8eb752..4a81b846 100644 --- a/packages/mobymask-watcher/README.md +++ b/packages/mobymask-watcher/README.md @@ -1,6 +1,6 @@ # MobyMask Watcher -First try the [stack orchestrator](https://github.com/cerc-io/stack-orchestrator) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. +First try the [mobymask demo in stack orchestrator](https://github.com/cerc-io/stack-orchestrator/tree/main/app/data/stacks/mobymask) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. ## Setup