feat: Improve README with prominent quickstart and Discord presence (#161)

* feat: Improve README with prominent quickstart and Discord presence

- Add Discord badge with live member count at top of badges
- Move Quick Start section higher in README for better visibility
- Add prominent link to 10-minute QUICKSTART.md guide
- Update navigation bar with Quick Start Guide as first item
- Include actual Discord and documentation URLs

This makes it easier for new users to get started quickly and join
the community for support.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Simplify Quick Start to use .env file approach

- Replace confusing docker run command with cleaner .env file setup
- Align README Quick Start with QUICKSTART.md approach
- Fix port inconsistency (8082 -> 3002) throughout README
- Make the 4-step process clearer and more concise

The .env file approach is much easier for users than passing
multiple environment variables to docker run.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Cheffromspace
2025-06-01 16:30:03 -05:00
committed by GitHub
parent 14785b2e64
commit f765e2ac3e

View File

@@ -1,5 +1,6 @@
# Claude GitHub Webhook
[![Discord](https://img.shields.io/discord/1377708770209304676?color=7289da&label=Discord&logo=discord&logoColor=white)](https://discord.gg/yb7hwQjTFg)
[![Main Pipeline](https://github.com/intelligence-assist/claude-hub/actions/workflows/main.yml/badge.svg)](https://github.com/intelligence-assist/claude-hub/actions/workflows/main.yml)
[![Security Scans](https://github.com/intelligence-assist/claude-hub/actions/workflows/security.yml/badge.svg)](https://github.com/intelligence-assist/claude-hub/actions/workflows/security.yml)
[![Jest Tests](https://img.shields.io/badge/tests-jest-green)](test/README.md)
@@ -9,6 +10,8 @@
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](package.json)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
🚀 **[Quick Start Guide](./QUICKSTART.md)** | 💬 **[Discord](https://discord.gg/yb7hwQjTFg)** | 📚 **[Documentation](https://docs.intelligence-assist.com/claude-hub/overview)** | 📖 **[Complete Setup](./docs/complete-workflow.md)** | 🔐 **[Authentication](./docs/claude-authentication-guide.md)**
![Claude GitHub Webhook brain factory - AI brain connected to GitHub octocat via assembly line of Docker containers](./assets/brain_factory.png)
Deploy Claude Code as a fully autonomous GitHub bot. Create your own bot account, mention it in any issue or PR, and watch AI-powered development happen end-to-end. Claude can implement complete features, review code, merge PRs, wait for CI builds, and run for hours autonomously until tasks are completed. Production-ready microservice with container isolation, automated workflows, and intelligent project management.
@@ -25,6 +28,29 @@ Deploy Claude Code as a fully autonomous GitHub bot. Create your own bot account
Claude autonomously handles complete development workflows. It analyzes your entire repository, implements features from scratch, conducts thorough code reviews, manages pull requests, monitors CI/CD pipelines, and responds to automated feedback - all without human intervention. No context switching. No manual oversight required. Just seamless autonomous development where you work.
## 🚀 Quick Start
**Follow our [10-minute Quick Start Guide](./QUICKSTART.md)** to get Claude responding to your GitHub issues using Cloudflare Tunnel - no domain or complex setup required!
```bash
# 1. Clone and configure
git clone https://github.com/intelligence-assist/claude-hub.git
cd claude-hub
cp .env.quickstart .env
nano .env # Add your GitHub token and bot details
# 2. Authenticate Claude (uses your Claude.ai Max subscription)
./scripts/setup/setup-claude-interactive.sh
# 3. Start the service
docker compose up -d
# 4. Create a tunnel (see quickstart guide for details)
cloudflared tunnel --url http://localhost:3002
```
That's it! Your bot is ready to use. See the **[complete quickstart guide](./QUICKSTART.md)** for detailed instructions and webhook setup.
## Autonomous Workflow Capabilities
### End-to-End Development 🚀
@@ -64,44 +90,6 @@ Claude autonomously handles complete development workflows. It analyzes your ent
- Container isolation with minimal permissions
- Fine-grained GitHub token scoping
## Quick Start
### Option 1: Docker Image (Recommended)
```bash
# Pull the latest image
docker pull intelligenceassist/claude-hub:latest
# Run with environment variables
docker run -d \
--name claude-webhook \
-p 8082:3002 \
-v /var/run/docker.sock:/var/run/docker.sock \
-e GITHUB_TOKEN=your_github_token \
-e GITHUB_WEBHOOK_SECRET=your_webhook_secret \
-e ANTHROPIC_API_KEY=your_anthropic_key \
-e BOT_USERNAME=@YourBotName \
-e AUTHORIZED_USERS=user1,user2 \
intelligenceassist/claude-hub:latest
# Or use Docker Compose
wget https://raw.githubusercontent.com/intelligence-assist/claude-hub/main/docker-compose.yml
docker compose up -d
```
### Option 2: From Source
```bash
# Clone and setup
git clone https://github.com/intelligence-assist/claude-hub.git
cd claude-hub
./scripts/setup/setup-secure-credentials.sh
# Launch with Docker Compose
docker compose up -d
```
Service runs on `http://localhost:8082` by default.
## Bot Account Setup
@@ -214,7 +202,7 @@ AWS_SECRET_ACCESS_KEY=xxx
Integrate Claude without GitHub webhooks:
```bash
curl -X POST http://localhost:8082/api/claude \
curl -X POST http://localhost:3002/api/claude \
-H "Content-Type: application/json" \
-d '{
"repoFullName": "owner/repo",
@@ -307,7 +295,7 @@ CLAUDE_CONTAINER_IMAGE=claudecode:latest
### Health Check
```bash
curl http://localhost:8082/health
curl http://localhost:3002/health
```
### Logs