Skip to content

Commit de983e9

Browse files
FloLeyclaude
andcommitted
Add GitHub installation instructions to README
- Include pip install from GitHub URL for easy installation without cloning - Provide examples for basic install and AI provider variants - Keep development installation instructions for contributors 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent dd1ff52 commit de983e9

1 file changed

Lines changed: 20 additions & 6 deletions

File tree

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,18 +189,32 @@ dumpcode --test-models
189189

190190
### Installation
191191

192+
#### From GitHub (Recommended)
192193
```bash
193194
# Basic installation
194-
pip install .
195+
pip install git+https://github.com/FloLey/dumpcode.git
195196

196197
# With AI support (all providers)
197-
pip install "dumpcode[ai]"
198+
pip install "git+https://github.com/FloLey/dumpcode.git#egg=dumpcode[ai]"
198199

199200
# With specific AI providers
200-
pip install "dumpcode[claude]" # Anthropic
201-
pip install "dumpcode[gemini]" # Google
202-
pip install "dumpcode[openai]" # OpenAI
203-
pip install "dumpcode[deepseek]" # DeepSeek
201+
pip install "git+https://github.com/FloLey/dumpcode.git#egg=dumpcode[claude]" # Anthropic
202+
pip install "git+https://github.com/FloLey/dumpcode.git#egg=dumpcode[gemini]" # Google
203+
pip install "git+https://github.com/FloLey/dumpcode.git#egg=dumpcode[openai]" # OpenAI
204+
pip install "git+https://github.com/FloLey/dumpcode.git#egg=dumpcode[deepseek]" # DeepSeek
205+
```
206+
207+
#### From Source (Development)
208+
```bash
209+
# Clone the repository
210+
git clone https://github.com/FloLey/dumpcode.git
211+
cd dumpcode
212+
213+
# Install in development mode
214+
pip install -e .
215+
216+
# Or with AI support
217+
pip install -e ".[ai]"
204218
```
205219

206220
### Configuration Setup

0 commit comments

Comments
 (0)