Merge pull request #121 from propeller-heads/dc/update-readme

docs: Link gitbook docs in the readmes
propeller-heads · Jan 6, 2025 · 1b510fe · 1b510fe
2 parents 7312a12 + f6a7045
commit 1b510fe
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -7,6 +7,7 @@ Moves slow on-chain computations off-chain to solve optimization problems.
 This crate allows simulating a set of supported protocols off-chain. Currently, it has a focus on token exchange
 protocols, but it is not necessarily limited to this.
 To get started, see our Quickstart guide [here](./examples/quickstart/Readme.md).
+For complete documentation, see Tycho docs [here](https://docs.propellerheads.xyz/tycho/for-solvers/simulation).
 
 > **See also:**
 > The `evm` module allows for simulating _any_ transaction; it is agnostic to protocol. See module's

diff --git a/examples/quickstart/Readme.md b/examples/quickstart/Readme.md
@@ -13,3 +13,6 @@ This quickstart guide enables you to:
 export RPC_URL=<your-eth-rpc-url>
 cargo run --release --example quickstart
 ```
+
+See [here](https://docs.propellerheads.xyz/tycho/for-solvers/tycho-quickstart) a complete guide on how to run the
+Quickstart example.