Circuit-Forge/peregrine
3
0
Fork 0
Code Issues 17 Pull requests Projects Releases 7 Packages Wiki Activity Actions

docs: fix repo URLs and clarify BYOK tier unlocking in feature matrix

Browse source 
Replace git.circuitforge.io/circuitforge/peregrine with the correct
Forgejo URL (git.opensourcesolarpunk.com/Circuit-Forge/peregrine) in
Quick Start, License, and Contributing clone instructions.

Update feature matrix in docs/index.md to show BYOK‡ for AI features
(cover letter, company research, interview prep, survey assistant) with
a footnote explaining the free-with-own-backend model. Previously the
table showed these as Paid-only, which would mislead self-hosters.
This commit is contained in:
pyr0ball 2026-05-18 12:05:03 -07:00
parent b44a7975bc
commit 7d1b1319be
2 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/developer-guide/contributing.md
View file

@ -11,7 +11,7 @@ Thank you for your interest in contributing to Peregrine. This guide covers the
## Fork and Clone ## Fork and Clone
```bash ```bash
git clone https://git.circuitforge.io/circuitforge/peregrine git clone https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine
cd peregrine cd peregrine
``` ```

21
docs/index.md
View file

@ -12,7 +12,7 @@ Peregrine automates the full job search lifecycle: discovery, matching, cover le
```bash ```bash
# 1. Clone and install dependencies # 1. Clone and install dependencies
git clone https://git.circuitforge.io/circuitforge/peregrine git clone https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine
cd peregrine cd peregrine
bash install.sh bash install.sh
@ -31,20 +31,23 @@ The first-run wizard guides you through hardware detection, tier selection, iden
## Feature Overview ## Feature Overview
| Feature | Free | Paid | Premium | | Feature | Free | Paid† | Premium |
|---------|------|------|---------| |---------|------|-------|---------|
| Job discovery (JobSpy + custom boards) | Yes | Yes | Yes | | Job discovery (JobSpy + custom boards) | Yes | Yes | Yes |
| Resume keyword matching | Yes | Yes | Yes | | Resume keyword matching | Yes | Yes | Yes |
| Cover letter generation | - | Yes | Yes | | Cover letter generation | BYOK‡ | Yes | Yes |
| Company research briefs | - | Yes | Yes | | Company research briefs | BYOK‡ | Yes | Yes |
| Interview prep & practice Q&A | - | Yes | Yes | | Interview prep & practice Q&A | BYOK‡ | Yes | Yes |
| Email sync & auto-classification | - | Yes | Yes | | Email sync & auto-classification | - | Yes | Yes |
| Survey assistant (culture-fit Q&A) | - | Yes | Yes | | Survey assistant (culture-fit Q&A) | BYOK‡ | Yes | Yes |
| Integration connectors (Notion, Airtable, etc.) | Partial | Yes | Yes | | Integration connectors (Notion, Airtable, etc.) | Partial | Yes | Yes |
| Calendar sync (Google, Apple) | - | Yes | Yes | | Calendar sync (Google, Apple) | - | Yes | Yes |
| Cover letter model fine-tuning | - | - | Yes | | Cover letter model fine-tuning | - | - | Yes |
| Multi-user support | - | - | Yes | | Multi-user support | - | - | Yes |
† **Paid** gives access to CircuitForge's hosted inference — no API key required.
‡ **BYOK** — configure any LLM backend in `config/llm.yaml` (local Ollama/vLLM or an API key) and these features unlock at no charge, regardless of tier.
See [Tier System](reference/tier-system.md) for the full feature gate table. See [Tier System](reference/tier-system.md) for the full feature gate table.
--- ---
@ -60,8 +63,8 @@ See [Tier System](reference/tier-system.md) for the full feature gate table.
## License ## License
Core discovery pipeline: [MIT](https://git.circuitforge.io/circuitforge/peregrine/src/branch/main/LICENSE-MIT) Core discovery pipeline: [MIT](https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine/src/branch/main/LICENSE-MIT)
AI features (cover letter generation, company research, interview prep, UI): [BSL 1.1](https://git.circuitforge.io/circuitforge/peregrine/src/branch/main/LICENSE-BSL) AI features (cover letter generation, company research, interview prep, UI): [BSL 1.1](https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine/src/branch/main/LICENSE-BSL)
© 2026 Circuit Forge LLC © 2026 Circuit Forge LLC