Skip to content

Commit 1e5e1d0

Browse files
committed
docs: Remove incorrect GitHub OAuth references from README
GitHub OAuth is not implemented - only email/password auth via Breeze. Added GitHub OAuth to roadmap as future feature.
1 parent ea319da commit 1e5e1d0

1 file changed

Lines changed: 4 additions & 13 deletions

File tree

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ PlanForge is a self-hosted project planning tool that uses AI to generate compre
1616
- **Task Generation** - Break down tech specs into actionable development tasks
1717
- **Version History** - Browse, preview, and restore previous document versions
1818
- **Kanban Board** - Drag-and-drop task management with Flowforge
19-
- **User Authentication** - Secure login with email/password or GitHub OAuth
19+
- **User Authentication** - Secure login with email/password
2020
- **Regeneration** - Regenerate individual documents or the entire pipeline
2121
- **Export** - Download project kit as ZIP (PRD, Tech Spec, Tasks, metadata)
2222
- **Rate Limit Resilience** - Graceful handling of API rate limits with automatic retries
@@ -26,7 +26,7 @@ PlanForge is a self-hosted project planning tool that uses AI to generate compre
2626
- **Backend**: Laravel 12, PHP 8.3+
2727
- **Frontend**: Livewire 3, Alpine.js, Tailwind CSS
2828
- **AI**: PrismPHP (Anthropic Claude, OpenAI, Google Gemini)
29-
- **Auth**: Laravel Breeze, Laravel Socialite
29+
- **Auth**: Laravel Breeze
3030
- **Kanban**: Filament 4 + Flowforge
3131
- **Database**: SQLite (default) or MySQL/PostgreSQL
3232
- **Queue**: Database driver (Redis optional)
@@ -84,7 +84,7 @@ Visit `http://localhost:8000` to create an account and get started.
8484

8585
## Usage
8686

87-
1. **Create Account** - Register with email/password or sign in with GitHub
87+
1. **Create Account** - Register with email/password
8888
2. **Create a Project** - Enter your project idea and any constraints
8989
3. **Generate** - Click "Generate All" to create PRD, Tech Spec, and Tasks
9090
4. **Review & Edit** - Edit the generated documents in the PRD and Tech tabs
@@ -156,16 +156,6 @@ GEMINI_API_KEY=...
156156
GEMINI_MODEL=gemini-2.0-flash # Optional
157157
```
158158

159-
### GitHub OAuth (Optional)
160-
161-
To enable "Sign in with GitHub":
162-
163-
```env
164-
GITHUB_CLIENT_ID=your-client-id
165-
GITHUB_CLIENT_SECRET=your-client-secret
166-
GITHUB_REDIRECT_URI=http://localhost:8000/auth/github/callback
167-
```
168-
169159
### Queue Driver
170160

171161
For production, consider using Redis:
@@ -182,6 +172,7 @@ REDIS_HOST=127.0.0.1
182172
- [x] ~~User authentication~~ (v0.4.0)
183173
- [x] ~~Version history~~ (v0.5.0)
184174
- [ ] GitHub Issues export
175+
- [ ] GitHub OAuth login
185176
- [ ] Team collaboration
186177
- [ ] Project templates
187178
- [ ] Diff comparison for versions

0 commit comments

Comments
 (0)