Update README.md

README.md

@@ -10,3 +10,112 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# Project Story Interview Chatbot
+
+A Gradio-based interview chatbot that collects project stories and automatically generates case study articles, submitting them to GitHub.
+
+## Features
+
+- **OpenAI-compatible interviewer LLM** - Conducts structured interviews about your project
+- **Availability checking** - Shows whether the interviewer is available or quota exceeded
+- **Browser-based persistence** - Chat history saved in localStorage
+- **AI article generation** - Uses Google Gemini to transform interview into a structured article
+- **GitHub integration** - Automatically commits articles to `_draft/` folder
+- **Post-submission flow** - Option to clear history or continue
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## Configuration
+
+Copy `.env.example` to `.env` and configure:
+
+```bash
+# Interviewer LLM (OpenAI-compatible API)
+INTERVIEWER_BASE_URL=http://your-server.com/v1
+INTERVIEWER_API_KEY=your-api-key
+INTERVIEWER_MODEL=gpt-4
+
+# Google Gemini for article generation
+GEMINI_API_KEY=your-gemini-api-key
+
+# GitHub repository for article submission
+GITHUB_TOKEN=your-github-personal-access-token
+GITHUB_REPO=owner/repository-name
+GITHUB_BRANCH=main
+```
+
+### Getting API Keys
+
+**OpenAI-compatible API:**
+- Use your own server running an OpenAI-compatible API (e.g., vLLM, LocalAI)
+- Or use OpenAI's API directly: `https://api.openai.com/v1`
+
+**Google Gemini:**
+- Get a free API key at [Google AI Studio](https://aistudio.google.com/app/apikey)
+
+**GitHub Token:**
+- Go to GitHub Settings → Developer settings → Personal access tokens → Tokens (classic)
+- Generate new token with `repo` scope
+- Or use fine-grained token with read/write access to Contents
+
+## Running
+
+```bash
+python app.py
+```
+
+The application will be available at `http://localhost:7860`
+
+## Customization
+
+### Article Writing Style
+
+Edit `article_instructions.md` to customize the writing style, structure, and guidelines for generated articles.
+
+### Interview Topics
+
+Modify the `SYSTEM_PROMPT` in `app.py` to change the interview focus areas.
+
+## Usage Flow
+
+1. **Start Interview** - Begins conversation with the interviewer AI
+2. **Share your story** - Answer questions about your project journey
+3. **Submit** - When complete, click "Generate & Submit Article"
+4. **Review** - Preview the generated article
+5. **Clear or Continue** - Choose to clear history or keep it for future editing
+
+## Troubleshooting
+
+**"Interviewer AI is off work now"**
+- Your API has exceeded quota/rate limits
+- Wait for quota to reset (usually daily)
+- Check API status on your provider's dashboard
+
+**"Gemini API key not configured"**
+- Make sure `GEMINI_API_KEY` is set in environment variables
+
+**"GitHub not configured"**
+- Ensure `GITHUB_TOKEN` and `GITHUB_REPO` are properly set
+- Verify token has write permissions to the repository
+
+**Chat history not persisting**
+- History is stored in browser localStorage
+- Clearing browser data will erase history
+- Use a consistent browser for continuity
+
+## Technical Details
+
+- Built with Gradio 6.x
+- Uses OpenAI Python SDK for interviewer LLM
+- Uses Google GenAI SDK for article generation
+- PyGithub for repository operations
+- LocalStorage for browser-side persistence
+
+## License
+
+MIT