diff --git a/README.md b/README.md index d891464..b4fb233 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,55 @@ Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes. +**Live at [codeboard.vectry.tech](https://codeboard.vectry.tech)** + +## Getting Started + +1. **Register** at [codeboard.vectry.tech/register](https://codeboard.vectry.tech/register) with your email and password. +2. **Log in** to access the dashboard, generation history, and settings. +3. **Paste a GitHub URL** and generate interactive onboarding documentation. + +Registration is required for full access. Unauthenticated visitors can view the landing page, but generating documentation, viewing your dashboard, and browsing generation history all require a logged-in account. + +## Plans and Pricing + +CodeBoard offers three billing tiers. One generation equals one documentation build from a repository URL. + +| Plan | Price | Generations | Highlights | +|------|-------|-------------|------------| +| **Free** | $0 | 15 per day | Public repos, architecture diagrams, interactive docs | +| **Starter** | $5 / month | 1,000 per month | Generation history, API key access, priority support | +| **Pro** | $20 / month | 100,000 per month | Full history, multiple API keys, dedicated support, custom integrations | + +Manage your subscription in **Settings > Billing** from the dashboard. + +## API Keys (Programmatic Access) + +Paid plans (Starter and Pro) include API key access for programmatic diagram and documentation generation. + +1. Navigate to **Settings > API Keys** in the dashboard. +2. Create a new key and copy it immediately -- it is shown only once. +3. Include the key in your requests: + +```bash +curl -X POST https://codeboard.vectry.tech/api/generate \ + -H "Authorization: Bearer YOUR_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{"repoUrl": "https://github.com/owner/repo"}' +``` + +Each successful API call counts as one generation against your plan's quota. + +## Generation History + +All generated documentation is saved to your account. From the dashboard you can: + +- Browse past generations per repository. +- Compare documentation versions side-by-side to track codebase changes over time. +- Re-open any previous generation by its unique link. + +History is per-user -- each account maintains its own generation records. + ## Architecture ```