From 8c783f9f33227d399359ef9d575dd092cd9cd8af Mon Sep 17 00:00:00 2001
From: Konst <johnysalvesen@gmail.com>
Date: Tue, 8 Oct 2024 19:53:29 +0300
Subject: [PATCH] Updated README.md

---
 README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 94 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 312525f..70022a7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,94 @@
-# starknet-metadata
-Metadata indexer for starknet
+# Starknet metadata indexer
+
+A DipDup Vertical component intended to indexing starknet tokens metadata
+
+## Features
+
+* Receiving metadata through IPFS and HTTP 
+* Receiving data through embedded IPFS node
+* Indexing `ERC20`, `ERC721` and `ERC1155` tokens
+
+## Public instances
+
+Public deployments with reasonable rate limits are available for testing and prototyping:
+* [Starknet metadata](https://ide.dipdup.io/?resource=starknet-metadata.dipdup.net/v1/graphql) `https://starknet-metadata.dipdup.net/v1/graphql`
+
+## Usage examples
+
+### Receiving ERC20 tokens metadata
+
+```gql
+query ERC20_token_metadata {
+    token_metadata(limit: 100, where: { type: { _eq: "erc20" } }) {
+        created_at
+        metadata
+        status
+        token_id
+        uri
+        type
+        updated_at
+        contract {
+            hash
+        }
+    }
+}
+```
+
+### Receiving certain contract tokens metadata 
+
+```gql
+query Contract_token_metadata {
+    token_metadata(
+        limit: 100
+        where: {
+            contract: {
+                hash: {
+                    _eq: "\\x01b10f6d79aa4b556a6c5a067596ca02d8dbf6566f1fbceee136bdaadd9fedc8"
+                }
+            }
+        }
+    ) {
+        metadata
+        contract {
+            hash
+        }
+        uri
+        created_at
+        token_id
+        type
+        updated_at
+    }
+}
+```
+
+### Indexer status
+To make sure the indexer works fine you can query status table
+
+```gql
+query State {
+    state {
+        last_time
+        last_height
+        name
+    }
+}
+```
+
+## Self hosted mode
+
+* Create `.env` file relying on [.env.example](https://github.com/dipdup-io/starknet-metadata/blob/master/.env.example)
+* Get Starknet node url endpoint for example on [Blast API](https://blastapi.io/public-api/starknet) and fill up `NODE_URL` variable
+* Run `docker compose up --build`
+
+## About
+
+DipDup Vertical for Starknet is a federated API including the following services:
+
+- [x] Generic Starknet indexer
+- [x] Starknet ID indexer
+- [x] Token metadata indexer
+- [ ] Starknet search engine (Q3)
+- [ ] Chain/dapp/contract analytics
+- [ ] Aggregated market data
+
+Project is supported by Starkware and Starknet Foundation via [OnlyDust platform](https://app.onlydust.xyz/projects/e1b6d080-7f15-4531-9259-10c3dae26848)