Merge pull request #141 from taikoxyz/doc

fix: docs
taikoxyz · Oct 28, 2024 · 6654edc · 6654edc
2 parents e841c24 + 233c430
commit 6654edc
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Open [`protocols.json`](./whitelist/protocols.json) and add a new protocol entry
 
 ### 2. Example Protocol Entry
 
-A new protocol entry needs atleast a name, slug and its contract addresses. Optionally, add twitter and logo reference. Logo must be stored under `/img`.
+A new protocol entry needs atleast a name, slug and its contract addresses. Optionally, add twitter and logo reference. Logo must be stored under `/img`. Ensure your slug is consistent with your project's slug used in Defillama if you are integrated.
 
 ```json
 {
@@ -25,6 +25,6 @@ A new protocol entry needs atleast a name, slug and its contract addresses. Opti
 
 Create a pull request (PR) on GitHub to merge your changes into the main branch. Provide a clear description of the changes and the protocol added.
 
-### 6. Review and Merge
+### 4. Review and Merge
 
 Wait for the PR to be reviewed by the maintainers. Once approved, your changes will be merged, and the new protocol will be added to the whitelist.
diff --git a/adapters/README.md b/adapters/README.md
@@ -4,9 +4,11 @@
 
 ### 1. Add your project under `adapters/projects`
 
+After the details of the indexer has been confirmed with the team, add your project's indexer in the `adapters/projects` folder.
+
 ### 2. Write an indexer in the new folder
 
-An example adapter for tracking OrderFulfilled Event on the OKX marketplace can be seen [here](./projects/okx/order_fulfilled.go)
+An example adapter for tracking OrderFulfilled Event on the OKX marketplace can be seen [here](./projects/okx/order_fulfilled.go) along with its accompanying test file.
 
 ### 3. Test out the adapter by adding it to the cli
 

diff --git a/whitelist/README.md b/whitelist/README.md
@@ -8,7 +8,7 @@ Open `protocols.json` and add a new protocol entry to the whitelist.
 
 ### 2. Example Protocol Entry
 
-A new protocol entry needs atleast a name, slug and its contract addresses. Optionally, add twitter and logo reference. Logo must be stored under `/img`.
+A new protocol entry needs atleast a name, slug and its contract addresses. Optionally, add twitter and logo reference. Logo must be stored under `/img`. Ensure your slug is consistent with your project's slug used in Defillama if you are integrated.
 
 ```json
 {
@@ -25,6 +25,6 @@ A new protocol entry needs atleast a name, slug and its contract addresses. Opti
 
 Create a pull request (PR) on GitHub to merge your changes into the main branch. Provide a clear description of the changes and the protocol added.
 
-### 6. Review and Merge
+### 4. Review and Merge
 
 Wait for the PR to be reviewed by the maintainers. Once approved, your changes will be merged, and the new protocol will be added to the whitelist.