Updated README.md file

Author: gsscoder

README.md

@@ -1,15 +1,39 @@
-# Basic Sample Hardhat Project
+# chainquery
 
-This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.
+Utilities to get data from from a blockchain using [UniswapV2Query](contracts/UniswapV2Query.sol) contract.
 
-Try running some of the following tasks:
+## Configuration
 
-```shell
-npx hardhat accounts
-npx hardhat compile
-npx hardhat clean
-npx hardhat test
-npx hardhat node
-node scripts/sample-script.js
-npx hardhat help
+Choose a consistent network name across the two configuration files.
+
+### .env
+
+```text
+PROVIDER_URL_MUMBAI="https://polygon-mumbai.g.alchemy.com/v2/..."
+ACCOUNT_KEY="5fa...9f39"
+UV2QUERY_ADDRESS_MUMBAI="0x460...7e67"
+```
+
+### appconfigs.json
+
+```json
+{
+  "network": "mumbai",
+  "dex": "quickswap",
+  "pairsChunkSize": 1000,
+  "cooldownMs": 1000,
+  "tokensChunkSize": 10,
+  "quickswapFactoryMumbai": "0x5757371414417b8C6CAad45bAeF941aBc7d3Ab32",
+  "outputPath": "./output"
+}
 ```
+
+## Usage
+
+- Deploy the contract: `npx hardhat run .\scripts\deploy.js --network mumbai`.
+
+- Set all needed configuration values.
+
+- Run [querypairs](scripts/querypairs.js) script to get token pairs from the configured DEX.
+
+- Run [querytokens](scripts/querytokens.js) to get tokens data using querypairs output.