Skip to content

Commit 3a7987e

Browse files
committed
docs: refine readme tone
1 parent c8babb2 commit 3a7987e

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,32 @@
1313

1414
<br>
1515

16-
### Sync issues both ways. GitHub ↔ Notion. Bumba Notion PM is a Node.js library that makes a Notion database the project management surface for any GitHub repository — with real bidirectional sync, rate-limited Notion API plumbing, and a CLI to wire it up in minutes. Issues created in GitHub appear in Notion. Tasks created in Notion appear in GitHub. Status, labels, assignees, links — all synchronized. ###
16+
### Sync issues both ways. GitHub ↔ Notion. Bumba Notion PM is a Node.js library for using a Notion database as a project management surface for GitHub repositories. It includes bidirectional issue sync, rate-limited Notion API helpers, built-in PM database schemas, and a CLI for setup and common workflows. ###
1717

1818
---
1919

20-
### 🔴 Bidirectional sync, no compromises ###
20+
### 🔴 Bidirectional sync, practical guardrails ###
2121

2222
- **GitHub → Notion**: Open and recently-closed issues become Notion pages with status, labels, and a back-link to the issue.
2323
- **Notion → GitHub**: Tasks created in Notion get filed as GitHub issues. The Notion page is updated with the new issue number and URL.
24-
- **Round-trip safe**: Once linked, a row's `GitHub Number` is the stable identity. Edit on either side; sync reconciles.
24+
- **Round-trip identity**: Once linked, a row's `GitHub Number` is used as the stable identity for future syncs.
2525
- **Three modes**: `bidirectional` (default), `github-to-notion`, `notion-to-github` — switch per-run.
2626

2727
---
2828

29-
### 🟡 Built for the Notion API, not against it ###
29+
### 🟡 Built around the Notion API ###
3030

31-
- **Rate-limited HTTP client** sized to Notion's 3 req/s budget — never get 429'd in a hot loop again.
31+
- **Rate-limited HTTP client** sized around Notion's documented request budget to reduce accidental 429s.
3232
- **Exponential backoff with jitter** on transient errors. Honors `Retry-After` when present.
3333
- **Typed errors**: `AuthError`, `RateLimitError`, `NotFoundError`, `ValidationError``instanceof` your way out of guesswork.
34-
- **Drop-in @notionhq/client shape**every method the official SDK exposes, but rate-limited.
34+
- **Familiar @notionhq/client shape**common SDK surfaces wrapped with rate limiting and retry behavior.
3535

3636
---
3737

38-
### 🟢 Zero-friction onboarding ###
38+
### 🟢 Lower-friction onboarding ###
3939

40-
- **Interactive setup wizard**: `npx bumba-notion-pm init` walks new users through token, parent page, and connection verification in under 2 minutes.
41-
- **Built-in PM schemas**: Tasks, Sprints, Epics, and Projects databases ready to spin up — no Notion-side hand-crafting.
40+
- **Interactive setup wizard**: `npx bumba-notion-pm init` walks through token, parent page, and connection verification.
41+
- **Built-in PM schemas**: Tasks, Sprints, Epics, and Projects database templates are available when you want a quick starting point.
4242
- **Block factory**: `heading`, `paragraph`, `bulletList`, `todoList`, `callout`, `code` — readable, composable, no manual JSON.
4343
- **Single-command database creation**: `bumba-notion-pm create-db -k tasks -t "My Tasks"`.
4444

@@ -48,7 +48,7 @@
4848

4949
- **Bring your own MCP server**: drop in a Notion MCP server and Bumba will auto-detect and route through it.
5050
- **Detection across transports**: HTTP, IPC socket, Claude Desktop config, or explicit env.
51-
- **Graceful fallback**: if MCP isn't there or fails mid-call, the bridge transparently falls back to the direct Notion API. Zero MCP infrastructure required to use the library.
51+
- **Graceful fallback**: if MCP isn't configured or fails mid-call, the bridge can fall back to the direct Notion API. No MCP infrastructure is required to use the library.
5252
- **Three modes**: `auto` (default), `mcp-only` (strict), `api-only` (skip detection).
5353

5454
<br>
@@ -159,7 +159,7 @@ npx bumba-notion-pm sync -r owner/name -d <database-id>
159159
npx bumba-notion-pm create-db -k tasks -t "Engineering Tasks"
160160
```
161161

162-
The database ships with `Status`, `Priority`, `Assignee`, `Due Date`, `GitHub Issue`, `GitHub Number`, `Labels`, and `Last Synced`all the columns the bridge needs, no manual configuration.
162+
The database ships with `Status`, `Priority`, `Assignee`, `Due Date`, `GitHub Issue`, `GitHub Number`, `Labels`, and `Last Synced` — the core columns the bridge expects.
163163

164164
<br>
165165

@@ -195,14 +195,14 @@ console.log(page.url);
195195

196196
<br>
197197

198-
### 🟡 Rate-limited Notion calls (handled for you) ###
198+
### 🟡 Rate-limited Notion calls ###
199199

200200
```javascript
201201
const { NotionClient } = require('bumba-notion-pm');
202202

203203
const client = new NotionClient(); // reads NOTION_API_KEY
204204

205-
// Drop-in replacement for @notionhq/client. Every call goes through the limiter.
205+
// Familiar @notionhq/client-style calls. Requests go through the limiter.
206206
await client.databases.query({ database_id: '...' });
207207
await client.pages.create({ parent: { page_id: '...' }, properties: { ... } });
208208
await client.blocks.children.append({ block_id: '...', children: [...] });

0 commit comments

Comments
 (0)