docs: sharpen README hero — 3-command self-host, blockquote value prop, cleaner flow#49
docs: sharpen README hero — 3-command self-host, blockquote value prop, cleaner flow#49alokit-bot wants to merge 1 commit into
Conversation
…p, cleaner flow - Replace verbose opening paragraph with a punchy blockquote value prop (one sentence, clear on what changes: CORS handled, keys never in code, costs on users' bill) - Add 'Get started' section right at the top with two clear paths: Option A = managed relay (zero setup), Option B = 3-command docker compose self-host + npm fallback for non-Docker users - Move 'How it works' flow diagram up before the comparison table (diagram → compare → quickstart is a more natural reading order) - Tighten 'How it compares' closing line with bold emphasis on the key differentiator - Remove redundant 'The problem' section (content absorbed into hero paragraph)
📝 WalkthroughWalkthroughThe README is restructured: the opening section gains a two-option "Get started" flow (hosted relay vs. self-host), the "The problem" block is replaced by a "How it works" sequence diagram showing browser→relay→AI provider interactions, and the "How it compares" section gains a sentence describing token placement and AES-256-GCM server-side key encryption. ChangesREADME Restructure
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
16-18: 💤 Low valueSpecify a language identifier for the fenced code block.
Line 16-18 contains a URL in a code fence without a language tag. While the content is just a plain URL, markdownlint expects all code blocks to declare a language for consistency.
✏️ Proposed fix
-``` +```text https://relay.byokrelay.com -``` +```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 16 - 18, The fenced code block containing the URL https://relay.byokrelay.com is missing a language identifier on the opening fence. Add a language tag (such as text) immediately after the opening triple backticks on the code fence to satisfy markdownlint requirements for all code blocks to declare a language for consistency.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 25-27: The README.md file contains Docker quickstart instructions
(lines 25-27) that reference running docker compose up -d, but the
docker-compose.yml file does not exist in the repository, causing the documented
quickstart to fail. Either create a docker-compose.yml file in the repository
root with proper configuration to run the relay service on port 3000 with the
required environment variables, or remove the Docker quickstart section from the
README and keep only the npm install and npm start alternative that is already
properly configured in package.json.
---
Nitpick comments:
In `@README.md`:
- Around line 16-18: The fenced code block containing the URL
https://relay.byokrelay.com is missing a language identifier on the opening
fence. Add a language tag (such as text) immediately after the opening triple
backticks on the code fence to satisfy markdownlint requirements for all code
blocks to declare a language for consistency.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| git clone https://github.com/avikalpg/byok-relay.git && cd byok-relay | ||
| echo "ENCRYPTION_SECRET=$(openssl rand -hex 32)" > .env | ||
| docker compose up -d # relay running at http://localhost:3000 |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify docker-compose.yml exists and check for npm start entrypoint
fd -e yml -e yaml | grep -i compose
grep -n "npm start" package.jsonRepository: avikalpg/byok-relay
Length of output: 45
🏁 Script executed:
#!/bin/bash
# List all yml/yaml files in the repository
echo "=== All YAML files ==="
find . -type f \( -name "*.yml" -o -name "*.yaml" \) 2>/dev/null | head -20
# Check if docker-compose.yml exists
echo "=== Checking for docker-compose files ==="
ls -la docker-compose.* 2>/dev/null || echo "No docker-compose files found"
# Check if package.json exists
echo "=== Checking for package.json ==="
ls -la package.json 2>/dev/null || echo "package.json not found"
# Check README.md content around lines 25-27
echo "=== README.md lines 20-35 ==="
sed -n '20,35p' README.md 2>/dev/null || echo "README.md not found or cannot be read"
# List all files in root directory
echo "=== Root directory files ==="
ls -la | head -30Repository: avikalpg/byok-relay
Length of output: 1888
🏁 Script executed:
#!/bin/bash
# Check package.json for npm start script
echo "=== package.json content ==="
cat package.jsonRepository: avikalpg/byok-relay
Length of output: 649
Add a docker-compose.yml file or remove the Docker quickstart from the README.
Line 25-27 instruct users to run docker compose up -d, but docker-compose.yml does not exist in the repository. This will cause the documented quickstart to fail. The npm fallback (npm install && npm start) is properly configured in package.json and works as an alternative, but the primary Docker path is broken and should either be implemented or removed from the README.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 25 - 27, The README.md file contains Docker
quickstart instructions (lines 25-27) that reference running docker compose up
-d, but the docker-compose.yml file does not exist in the repository, causing
the documented quickstart to fail. Either create a docker-compose.yml file in
the repository root with proper configuration to run the relay service on port
3000 with the required environment variables, or remove the Docker quickstart
section from the README and keep only the npm install and npm start alternative
that is already properly configured in package.json.
1 participant
GROWTH_PLAN Day 9 — README Hero Improvements
Goal: Better first impression for visitors (developers, agent-referred users, GitHub search).
What changed
Opening value prop (hero):
Get started section (3-command self-host):
clone → .env → docker compose up -d)npm install && npm startStructure cleanup:
## How it works(was floating below comparison table)## The problemsection (content absorbed into hero paragraph)Why this matters
The previous README buried the "why" behind a wordy paragraph and had no quick path to running the relay. A developer who lands on the repo from a search or an agent referral should understand the value prop in 5 seconds and be able to try it in under a minute.
Summary by CodeRabbit