From c8a200dc55bf1c137d0412b0c83c1d7808ea6412 Mon Sep 17 00:00:00 2001 From: Diana Carvalho Date: Fri, 7 Feb 2025 16:16:55 +0000 Subject: [PATCH] docs: Add mention to the quickstart in the main README.md --- don't change below this line --- ENG-4088 Took 5 minutes --- README.md | 4 ++++ examples/quickstart/{Readme.md => README.md} | 0 2 files changed, 4 insertions(+) rename examples/quickstart/{Readme.md => README.md} (100%) diff --git a/README.md b/README.md index c5f163e..bc64ddd 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Tycho Execution makes it easy to trade on different DEXs by handling the complex custom code for each DEX, you get a simple, ready-to-use tool that generates the necessary data to execute trades. It's designed to be safe, straightforward, and quick to set up, so anyone can start trading without extra effort. +## Quickstart + +To get started, have a look at our [Quickstart example](examples/quickstart/README.md). + ## Bin Usage Guide ### Installation diff --git a/examples/quickstart/Readme.md b/examples/quickstart/README.md similarity index 100% rename from examples/quickstart/Readme.md rename to examples/quickstart/README.md