Updated README.md file

README.md

@@ -1,69 +1,60 @@
-# ContribNavigator
-
-ContribNavigator is an AI-assisted tool designed to help developers, especially newcomers, find and begin contributing to open-source projects on GitHub. It streamlines issue discovery and provides an intelligently generated onboarding kit.
-
-## Core Features
-
-*   **Targeted Issue Search:** Filters GitHub issues by programming language and user-specified topics (e.g., "python" + "machine-learning"), prioritizing beginner-friendly labels like "good first issue."
-*   **AI-Powered Issue Suggestion:** Leverages an LLM (OpenAI GPT-4o class) to analyze fetched issues and recommend the most suitable starting point for a beginner, with clear reasoning.
-*   **Intelligent Onboarding Kit:**
-    *   **AI-Planned Components:** An LLM planner dynamically determines the most relevant sections to include in the kit based on the selected issue.
-    *   **Essential Information:** Direct links to the issue and repository, `git clone` command.
-    *   **Contribution Guidelines Analysis:**
-        *   Link to the project's `CONTRIBUTING.md` (or similar).
-        *   AI-generated summary of key contribution procedures (setup, coding style, PR process).
-    *   **Repository Overview (via Modal):**
-        *   Top-level file and directory listing from a sandboxed `git clone` operation executed on Modal.
-        *   AI-suggested relevant files/folders to investigate for the specific issue.
-*   **First Steps Checklist:** An interactive checklist in the UI to guide users through their initial contribution actions.
-*   **Agentic Design:** Built with an agentic architecture where an LLM plans and orchestrates the use of internal "tools" (GitHub API client, Modal repo inspector, LLM analysis functions), aligning with Model Context Protocol (MCP) principles.
-
-## Tech Stack
+---
+title: ContribNavigator
+emoji: 🧭
+colorFrom: blue
+colorTo: green
+sdk: gradio
+python_version: "3.12" 
+sdk_version: "4.29.0" # Example: Use a recent Gradio version, check your requirements or latest stable
+app_file: app.py
+pinned: false
+license: mit
+short_description: "AI copilot for beginner open-source issues & planned kits."
+tags: ["agent", "llm", "openai", "modal", "github", "open-source", "developer-tools", "gradio-agent-hackathon", "mcp-hackathon"]
+
+
+## ContribNavigator: Your AI Guide to Open Source Contributions
+
+**Find beginner-friendly open-source issues and get an AI-planned onboarding kit to kickstart your contribution!**
+
+ContribNavigator is an intelligent agent built with Gradio that simplifies finding and starting your first open-source contribution. It uses AI to suggest relevant issues and dynamically generates a comprehensive onboarding kit.
+
+### How to Use:
+
+1.  **Select Programming Language:** Choose your preferred language from the dropdown.
+2.  **Specify Topics (Optional):**
+    *   Select common topics from the multi-select dropdown.
+    *   Add any custom, comma-separated topics (slugs or phrases like "web development") in the textbox.
+3.  **Find Issues:** Click "🔍 Find Beginner Issues."
+    *   The app will display recommended issues and an AI Navigator's Insight suggesting a good starting point.
+4.  **Generate Onboarding Kit:**
+    *   Select an issue from the "Select an Issue to Generate Kit" dropdown (this appears after issues are found).
+    *   Click "🛠️ Generate Onboarding Kit."
+    *   View your personalized kit, which includes:
+        *   Issue and repository links.
+        *   `git clone` command.
+        *   AI-summarized contribution guidelines (if found).
+        *   A repository file structure overview (from a sandboxed clone via Modal).
+        *   AI-suggested relevant files to start your investigation.
+        *   An interactive "First Steps Checklist."
+
+### Key Features & Technologies:
+
+*   **Smart Issue Discovery:** Filters by language and topics, prioritizing beginner-friendly labels.
+*   **AI-Powered Suggestions:** Uses OpenAI (GPT-4o class model) for issue recommendations, contribution guideline summaries, and relevant file suggestions.
+*   **Intelligent Onboarding Kit:** Dynamically planned by an LLM to include the most relevant information.
+*   **Sandboxed Repo Analysis:** Leverages Modal to securely clone repositories and list files.
+*   **Agentic Design:** Built with an agentic architecture where an LLM plans and orchestrates the use of internal "tools," reflecting Model Context Protocol (MCP) principles.
+
+### Technical Stack:
 
 *   **UI:** Gradio
-*   **Backend & Orchestration:** Python
-*   **Language Models:** OpenAI API (GPT-4o class)
-*   **Sandboxed Operations:** Modal (for `git clone`)
-*   **Data Source:** GitHub API
-
-## Local Development Setup
-
-1.  **Prerequisites:**
-    *   Git
-    *   Python (3.10+)
-    *   Modal Account & CLI (`modal token new`)
-
-2.  **Clone & Install Dependencies:**
-    ```bash
-    git clone https://github.com/YOUR_USERNAME/ContribNavigator.git # Replace with your repo URL
-    cd ContribNavigator
-    python -m venv .venv
-    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
-    pip install -r requirements.txt
-    ```
-
-3.  **Environment Variables:**
-    *   Create a `.env` file in the project root (refer to `.env.example` if provided).
-    *   Add your API keys:
-        ```env
-        GITHUB_PAT="your_github_pat"
-        OPENAI_API_KEY="sk-your_openai_key"
-        # MODAL_TOKEN_ID="mi_..." # Optional for local if `modal token new` was used
-        # MODAL_TOKEN_SECRET="ms_..." # Optional for local
-        ```
-
-4.  **Run the Application:**
-    ```bash
-    python app.py
-    ```
-
-## Hackathon Context
-
-*   **Project:** ContribNavigator
-*   **Event:** Agents & MCP Hackathon
-*   **Primary Track Submission:** Agentic Demos Track
-    *   *Demonstrates an end-to-end AI agent application using Gradio that assists with open-source contributions through intelligent planning and tool utilization (GitHub API, Modal, LLM analysis), reflecting MCP principles.*
+*   **Backend:** Python
+*   **LLMs:** OpenAI API
+*   **Cloud Functions:** Modal
+*   **Data:** GitHub API
 
-## License
+---
 
-This project is licensed under the MIT License. See the `LICENSE` file for details.
+This Space is a submission for the **Agents & MCP Hackathon**.
+For more details, local setup instructions, and the full source code, please visit our [GitHub Repository](https://github.com/YOUR_USERNAME/ContribNavigator). <!-- Replace with your GitHub repo URL -->