Update README.md

README.md

@@ -10,4 +10,50 @@ pinned: false
 license: apache-2.0
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Github Repo Visualizer 🌍
+
+Github Repo Visualizer is a tool to visualize GitHub repositories using Gradio.
+
+## Table of Contents
+- [Github Repo Visualizer 🌍](#github-repo-visualizer-)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Usage](#usage)
+- [App Flow](#app-flow)
+
+## Installation
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/yourusername/Github-Repo-Visualizer.git
+    cd Github-Repo-Visualizer
+    ```
+
+2. Install the required dependencies:
+    ```sh
+    pip install -r requirements.txt
+    ```
+
+## Usage
+
+To run the application, execute:
+```sh
+python app.py
+```
+
+# App Flow
+
+```mermaid
+graph TD
+    A[Input Repo] --Get Repo Info--> B[Load Repo]
+    B --Plan a exploration strategy--> C[planner]
+    C --Explore files based on graph--> D[explore_file]
+    D --Summarize dependencies and functionalities--> E[get_file_content_summary]
+    E --Build undersrtanding and generte graph--> F[generate_mermaid_code]
+    F --Fix errors and render--> G[render_mermaid]
+```
+
+- Please visit `prompt.py` to see the different prompts used for each functionality.
+- Please note that the exploration is capped to top 25 files based on the plan.
+- `utils.py` contains all the nodes and edge functions used in the graph.
+- `app.py` contains the main code for graph compilation and run.