rv-bible-cli 0.1.2 → 0.1.4

package/README.md

@@ -2,20 +2,50 @@
 
 A fast, study-grade terminal Bible reader for the Recovery Version. Offline-first, footnote-aware, cross-reference deep-linking, clipboard-friendly.
 
+![rvb demo](https://i.imgur.com/a/r6tcBmY.gif)
+
+## Installation
+
+### 1. Install Node.js (if you don't have it)
+
+**Mac:**
+```bash
+# Option A: Download the installer from https://nodejs.org (pick LTS)
+# Option B: Using Homebrew
+brew install node
 ```
+
+**Windows:**
+1. Go to [https://nodejs.org](https://nodejs.org)
+2. Download the **LTS** installer
+3. Run the installer — accept the defaults
+4. Restart your terminal (PowerShell or Command Prompt)
+
+To verify Node.js is installed, open a terminal and run:
+```bash
+node --version    # should print v18 or higher
+```
+
+### 2. Install rvb
+
+Open your terminal and run:
+```bash
 npm install -g rv-bible-cli
-rvb
 ```
 
-> **Note:** `rv` also works as an alias on Mac/Linux.
+That's it. Now type `rvb` to launch.
+
+> **Windows note:** In PowerShell, use `rvb` (not `rv`). On Mac/Linux, both `rv` and `rvb` work.
 
 ## Quick Start
 
 ```bash
-rvb john 3          # read a chapter (interactive pager)
+rvb                 # home screen — browse all 66 books
+rvb john 3          # read a chapter
 rvb john 3:16       # read a single verse
-rvb search grace    # concordance search (1,129 curated words)
-rvb help            # see all commands and shortcuts
+rvb search grace    # search the Bible
+rvb continue        # resume where you left off
+rvb help            # see all commands
 ```
 
 ## Features
@@ -23,7 +53,7 @@ rvb help            # see all commands and shortcuts
 ### Reading
 
 ```bash
-rvb john 3              # chapter mode — opens full-screen pager
+rvb john 3              # chapter mode — opens interactive pager
 rvb john 3:16           # single verse
 rvb john 3:16-18        # verse range
 rvb john 3:16,18,20     # specific verses
@@ -45,14 +75,13 @@ rvb note john 3:14-16   # footnotes for a range
 
 ### Search
 
-Concordance-first for known words (1,129 curated entries), FTS5 full-text for everything else.
+Concordance-first for known words (1,129 curated entries), full-text for everything else.
 
 ```bash
 rvb search grace              # concordance lookup
 rvb search grace in romans    # scoped to a book
 rvb search "only begotten"    # phrase match
 rvb search eternal life       # multi-word AND
-rvb search grace --fts        # force raw FTS5
 rvb search grace --all        # show all results (default: 20/page)
 ```
 
@@ -63,9 +92,9 @@ Add `--copy` to any read command. Output displays normally AND goes to clipboard
 ```bash
 rvb john 3:16 --copy              # "John 3:16 For God so loved..."
 rvb john 3:16 --copy --no-ref     # plain text only
-rvb john 3:16 --copy --numbered   # "16 For God so loved..."
+rvb john 3:16 --copy --numbered   # verse number prefix
 rvb john 3:16 --copy --md         # markdown block quote
-rvb search grace --copy           # copy all results
+rvb search grace --copy           # copy all search results
 ```
 
 ### Navigation
@@ -75,74 +104,76 @@ rvb                # home screen — browse books, pick chapters
 rvb continue       # resume last-read chapter
 ```
 
-## Pager
+## Interactive Pager
 
-Chapter mode in a terminal automatically launches a full-screen interactive pager.
+When you read a chapter in a terminal, rvb opens a full-screen interactive reader — like a book in your terminal.
 
-### Normal Mode
+### Reading Mode
 
 | Key | Action |
 |-----|--------|
 | `j` / `k` / arrows | scroll up/down |
 | `Space` / `b` | page down/up |
-| `g` / `G` | top / bottom |
-| `n` / `p` / left/right | next / prev chapter (cross-book) |
-| `f` | toggle footnotes |
-| `o` | toggle outline |
-| `+` / `-` | adjust text width (wider margins / tighter) |
-| `0` | reset width to default |
+| `g` / `G` | jump to top / bottom |
+| left / right | prev / next chapter (even across books) |
+| `f` | toggle footnotes on/off |
+| `o` | toggle outline on/off |
+| `+` / `-` | adjust text width |
 | `d` | enter study mode |
 | `c` | enter copy mode |
-| `/` | search within chapter |
-| `:` | goto — type a reference (e.g. `rom 8`) |
-| `[` / `]` | back / forward (navigation history) |
-| `H` | home screen |
-| `q` / `Esc` | quit |
+| `/` | find text in current chapter |
+| `:` | jump to any book — type `rom 8`, `jn 3`, etc. |
+| `[` / `]` | go back / forward (like browser history) |
+| `H` | go to home screen |
+| `q` | quit |
+
+> **Tip:** To make the text bigger or smaller, use your terminal's font size shortcut: `Cmd +/-` on Mac, `Ctrl +/-` on Windows/Linux.
 
 ### Study Mode (`d`)
 
-Browse footnotes and follow cross-references. Auto-enables notes and outline on entry. The footnote panel updates dynamically as you move between verses.
+Deep-dive into footnotes and cross-references. Press `d` while reading any chapter.
+
+- A cursor highlights the current verse
+- The bottom panel shows all footnotes for that verse with numbered cross-references
+- **Type a number** to follow a cross-reference — you'll jump to that chapter and land on the exact verse
+- Press `[` to go back to where you were
+- Study mode stays active as you navigate — it's designed for chaining through references
 
 | Key | Action |
 |-----|--------|
-| up/down | move verse cursor |
-| left/right | prev / next chapter |
-| type number | follow a numbered cross-reference |
-| `v` | start range selection |
-| `c` | copy verse or range |
-| `f` | toggle footnotes |
-| `o` | toggle outline |
-| `/` | search within chapter |
-| `:` | goto |
-| `[` / `]` | back / forward |
-| `d` / `Esc` | exit study mode |
-
-Study mode persists across navigation — follow a cross-ref and you stay in study mode, landing on the exact target verse. Press `[` to go back.
+| up / down | move between verses |
+| left / right | prev / next chapter |
+| type number | follow a cross-reference |
+| `v` then up/down then `c` | select a range and copy |
+| `c` | copy current verse |
+| `f` / `o` | toggle footnotes / outline |
+| `/` | find text |
+| `:` | jump to a book |
+| `d` or `Esc` | exit study mode |
 
 ### Copy Mode (`c`)
 
+Select and copy verses to your clipboard without leaving the pager.
+
 | Key | Action |
 |-----|--------|
-| up/down | move verse cursor |
-| `v` | start range selection |
-| `Enter` / `c` | copy to clipboard |
+| up / down | move verse cursor |
+| `v` | start selecting a range |
+| `Enter` or `c` | copy to clipboard |
 | `Esc` | cancel |
 
 ### Home Screen
 
-Press `H` from the pager or run `rvb` with no arguments.
+Run `rvb` with no arguments, or press `H` from the pager.
 
-| Key | Action |
-|-----|--------|
-| arrows | navigate the book grid |
-| type a letter | jump to first matching book (repeat to cycle) |
-| `Enter` | select book, then pick chapter |
-| `Space` | continue last-read chapter |
-| `q` | quit |
+- Arrow keys navigate the book grid (Old Testament + New Testament)
+- Type a letter to jump to matching books (press again to cycle)
+- `Enter` selects a book, then pick a chapter
+- `Space` continues where you left off
 
-## Database
+## What's Included
 
-The bundled SQLite database (`rv.db`, 43 MB) contains:
+The entire Recovery Version Bible is bundled offline — no internet needed, no accounts, no setup.
 
 | Content | Count |
 |---------|-------|
@@ -153,12 +184,11 @@ The bundled SQLite database (`rv.db`, 43 MB) contains:
 | Section headers | 2,907 |
 | Concordance entries | ~110,000 |
 
-All data is from the Recovery Version Bible. Offline — no network requests.
-
-## Requirements
+## Updating
 
-- Node.js 18+
-- A terminal that supports ANSI colors
+```bash
+npm install -g rv-bible-cli@latest
+```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rv-bible-cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Fast, offline terminal Bible reader for the Recovery Version. Footnotes, cross-references, concordance search, interactive pager.",
   "type": "module",
   "main": "dist/index.js",