From f14b33554a9068561a4f01031eb05a8011bed217 Mon Sep 17 00:00:00 2001
From: Adii <77727680+AdityaMotale@users.noreply.github.com>
Date: Tue, 6 Feb 2024 20:03:14 +0530
Subject: [PATCH] added docs

---
 README.md  | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 index.html |  5 ++++
 2 files changed, 79 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index d205456..2604602 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,77 @@
 # Bharat City Connect 🇮🇳
 
-Bharat City Connect is a repository of JSON files containing data on states and cities across Bharat 🇮🇳.
+Welcome to Bharat City Connect, your one-stop destination for detailed geographical information
+about different states and cities across Bharat 🇮🇳! This repository contains JSON files filled with
+valuable data that will help you understand the layout of our diverse country better.
 
-This resource enables seamless retrieval of essential geographic information, fostering connectivity and
-awareness nationwide.
+## Overview
+
+The goal of this API is to provide an easy-to-use yet comprehensive collection of state and city data,
+facilitating smooth integration into applications and projects requiring such details.
+
+By promoting awareness and accessibility, I aim to strengthen the bond between every corner
+of Bharat 🇮🇳.
+
+## Documentation
+
+### Base API URL
+
+The base URL for the API is as follows:
+
+```bash
+https://adityamotale.github.io/bharat_city_connect/api/
+```
+
+You may use this base URL to construct specific endpoint paths for fetching desired data sets.
+
+### Accessing State Data
+
+To obtain all available states, simply navigate to:
+
+```bash
+https://adityamotale.github.io/bharat_city_connect/api/bharat.json
+```
+
+The response format will resemble this example output:
+
+```js
+[
+  {
+    "state_name": "Andaman_and_Nicobar_Islands"
+  }
+  // ...other states follow here
+]
+```
+
+### Retrieving City Information
+
+Once you acquire the name of a particular state from the master list (accessed via `<base_url>/bharat.json`),
+you can proceed by appending its name (without spaces or special characters) to the following path:
+
+```bash
+https://adityamotale.github.io/bharat_city_connect/api/states/{state_name}.json
+```
+
+Replace `{state_name}` with the actual state name you wish to explore further.
+
+For instance, if you want to find out which cities belong to the Andaman & Nicobar Islands,
+query the respective endpoint below:
+
+```bash
+https://adityamotale.github.io/bharat_city_connect/api/states/Andaman_and_Nicobar_Islands.json
+```
+
+The corresponding response will look like this:
+
+```js
+[
+  {
+    "city_name": "Port Blair"
+  }
+  // ...other cities follow here
+]
+```
+
+For more information or to report issues, please open a PR or Issue with your proposed changes.
+
+Happy exploring 🇮🇳!
diff --git a/index.html b/index.html
index 0b996b0..974bb6d 100644
--- a/index.html
+++ b/index.html
@@ -15,5 +15,10 @@ <h1>Bharat City Connect</h1>
       This resource enables seamless retrieval of essential geographic
       information, fostering connectivity and awareness nationwide.
     </p>
+    <a
+      href="https://github.com/AdityaMotale/bharat_city_connect?tab=readme-ov-file#bharat-city-connect-"
+    >
+      Read docs to start using the API
+    </a>
   </body>
 </html>