From 63b242792d7b96c5b66f29f83301a6be0027b401 Mon Sep 17 00:00:00 2001
From: David Vilela <dvilelaf@gmail.com>
Date: Wed, 12 Jul 2023 11:17:05 +0200
Subject: [PATCH 1/2] chore: readme

fix: ignore leak


fix: typo


fix: readme
---
 .gitleaksignore |  1 +
 README.md       | 67 ++++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 67 insertions(+), 1 deletion(-)

diff --git a/.gitleaksignore b/.gitleaksignore
index 9bc07527..2ad8639e 100644
--- a/.gitleaksignore
+++ b/.gitleaksignore
@@ -1,3 +1,4 @@
 827bf64c3cabfeb82de205e0914f4c6884ee0eac:packages/valory/skills/trader_abci/skill.yaml:generic-api-key:80
 64ceb66bf1bd9d3872d95dfea998e723fdee297c:packages/valory/skills/decision_maker_abci/skill.yaml:generic-api-key:84
 9c3fa1a89cd918ca1a1c74ad5efd48f9ec106c34:packages/valory/skills/market_manager_abci/skill.yaml:generic-api-key:68
+62f2fabeeb87ccbe9b8a880d832a1028d92ae596:README.md:generic-api-key:60
diff --git a/README.md b/README.md
index 44f282fa..ab5672a3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,66 @@
-## Trader
\ No newline at end of file
+## Trader
+
+Trader is an autonomous service that performs bets on prediction markets on the Gnosis chain.
+
+## Developers
+
+- Clone the repository:
+
+      git clone https://github.com/valory-xyz/trader.git
+
+- System requirements:
+
+    - Python `== 3.10`
+    - [Tendermint](https://docs.tendermint.com/v0.34/introduction/install.html) `==0.34.19`
+    - [Poetry](https://python-poetry.org/docs/) `>=1.4.0`
+    - [Docker Engine](https://docs.docker.com/engine/install/)
+    - [Docker Compose](https://docs.docker.com/compose/install/)
+
+- Create development environment:
+
+      poetry install && poetry shell
+
+- Configure command line:
+
+      autonomy init --reset --author valory --remote --ipfs --ipfs-node "/dns/registry.autonolas.tech/tcp/443/https"
+
+- Pull packages:
+
+      autonomy packages sync --update-packages
+
+## Testing the service against Gnosis  Mainnet
+
+* Prepare some environment variables:
+    ```
+    export RPC_0=INSERT_YOUR_RPC
+    export CHAIN_ID=100
+    export ALL_PARTICIPANTS='["YOUR_AGENT_ADDRESS"]'
+    export SAFE_CONTRACT_ADDRESS="YOUR_SAFE_ADDRESS"
+    ```
+
+* Fetch the service
+    ```
+    autonomy fetch --local --service valory/trader && cd trader
+    ```
+
+* Build the image:
+    ```
+    autonomy build-image
+    ```
+
+* Prepare the agent keys:
+    ```
+    cat > keys.json << EOF
+    [
+    {
+        "address": "<your_agent_address>",
+        "private_key": "<your_agent_private_key>"
+    }
+    ]
+    EOF
+    ```
+* Build the deployment and run:
+    ```
+    autonomy deploy build --n 1 -ltm
+    autonomy deploy run --build-dir abci_build/
+    ```

From 140ed623b10a708c196559be0fb927c60e3724fc Mon Sep 17 00:00:00 2001
From: David Vilela <dvilelaf@gmail.com>
Date: Wed, 12 Jul 2023 11:45:44 +0200
Subject: [PATCH 2/2] fix: skip url

---
 .github/workflows/common_checks.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/common_checks.yaml b/.github/workflows/common_checks.yaml
index 0e3753a1..a4ab127c 100644
--- a/.github/workflows/common_checks.yaml
+++ b/.github/workflows/common_checks.yaml
@@ -61,7 +61,7 @@ jobs:
     - name: Check dependencies
       run: tox -e check-dependencies
     - name: Check doc links
-      run: tomte check-doc-links
+      run: tomte check-doc-links --url-skips https://github.com/valory-xyz/trader.git
     - name: Check doc IPFS hashes
       run: tox -e check-doc-hashes