readshell 0.3.2 → 1.0.0

package/LICENSE

@@ -1,17 +1,21 @@
-GNU AFFERO GENERAL PUBLIC LICENSE
-Version 3, 19 November 2007
+MIT License
 
-Copyright (C) 2026 ReadShell
+Copyright (c) 2026 ReadShell / davidy
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Affero General Public License for more details.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-You should have received a copy of the GNU Affero General Public License
-along with this program. If not, see <https://www.gnu.org/licenses/>.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -8,10 +8,10 @@
 
 [![npm version](https://img.shields.io/npm/v/readshell.svg)](https://www.npmjs.com/package/readshell)
 [![npm downloads](https://img.shields.io/npm/dm/readshell.svg)](https://www.npmjs.com/package/readshell)
-[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
-[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18-green.svg)](https://nodejs.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D20-green.svg)](https://nodejs.org)
 
-*A low-friction reading tool for developers who never leave the terminal.*
+*A low-friction reading tool for developers who never leave the terminal. Free and open source — no accounts, no servers, no paid tier.*
 
 ![ReadShell Demo](./docs/demo.gif)
 
@@ -40,19 +40,24 @@ One command. Back to where you were. Back to work when you're ready.
 The most important command. Picks up exactly where you left off, down to the byte.
 
 **🥷 Boss Key (`b` / `Esc`) — Instant disguise**
-One keypress transforms the reader into a convincing terminal error log. Your secret is safe.
+One keypress transforms the reader into a convincing terminal error log (nodejs / python / java / c / go). Your secret is safe.
+![Boss Key Demo](./docs/error.png)
+*Boss Key wipes the scrollback buffer and shows a fake error. `novel resume` jumps back to the exact spot.*
 
-**⏱ Reading time estimate**
-Calibrated to your actual reading speed. Tells you if you have time for one more chapter.
+**🔄 Folder sync — multi-device, no server**
+Point ReadShell at any folder synced by iCloud Drive, Dropbox, OneDrive, 坚果云, or Syncthing. Progress, bookmarks (including deletions), and reading stats merge across devices automatically on open/exit. Nothing is ever uploaded to a ReadShell server — there isn't one.
 
-**🔖 Bookmarks (`m`)**
-Capture a passage mid-read. Revisit it later from the chapter navigator (`c`).
+**📊 `novel stats` — GitHub-style heatmap**
+A year of reading at a glance, plus reading days, total time, books read, and streaks — aggregated across all synced devices.
+
+**🔖 Bookmarks (`m`) + free export**
+Capture a passage mid-read, revisit via the chapter navigator (`c`), export everything with `novel bookmarks export --format md|json`.
 
 **📚 Batch import**
-`novel import ~/books/` — recursively imports an entire folder of `.txt` and `.epub` files.
+`novel import ~/books/` — recursively imports `.txt`, `.epub`, and `.md` files.
 
 **🌐 i18n**
-Native English and Chinese support.
+Native Chinese and English support (`novel lang zh|en`).
 
 ---
 
@@ -78,8 +83,9 @@ novel list
 
 | Key | Action |
 |---|---|
-| `Space` / `j` / `↓` | Next page / scroll down |
+| `Space` / `j` / `↓` / `f` | Next page / scroll down |
 | `k` / `↑` | Previous page / scroll up |
+| `g` / `G` | First / last page |
 | `c` | Chapter list & bookmarks |
 | `Tab` | Toggle chapters / bookmarks |
 | `m` | Add bookmark |
@@ -87,14 +93,56 @@ novel list
 | `q` | Quit & save |
 | `?` | Help |
 
-### Configuration
+### Commands
+```bash
+novel import <path>                    # file or directory (txt / epub / md)
+novel list                             # library
+novel open <id|title>                  # open a book
+novel resume                           # resume last position
+novel remove <id|title>                # remove from library
+novel stats                            # reading heatmap & streaks
+novel bookmarks export [--format json|md] [--out file]
+novel sync --dir <path> [--with-books] # set sync folder & sync
+novel sync                             # sync with saved folder
+novel sync --off                       # disable sync
+novel lang zh|en                       # interface language
+novel config <key> <value>             # language | line-spacing | reading-mode | boss-key-lang
+novel update                           # update to latest
+```
+
+---
+
+## Folder Sync
+
+ReadShell syncs through a plain folder — no account, no server. Each device writes a snapshot to `<syncDir>/readshell-sync/devices/<deviceId>.json` and merges every other device's file (last-write-wins progress, bookmark tombstones, session union).
+
+Pick a folder that your sync tool already watches:
+
+```bash
+# iCloud Drive (macOS)
+novel sync --dir "$HOME/Library/Mobile Documents/com~apple~CloudDocs/ReadShell"
+
+# Dropbox
+novel sync --dir ~/Dropbox/ReadShell
+
+# 坚果云 / OneDrive / Syncthing — same idea, any synced folder
+novel sync --dir ~/Nutstore/ReadShell
+```
+
+Add `--with-books` to also copy book files into the sync folder — other devices will auto-import books they don't have yet. Without it, only progress/bookmarks/stats sync (books are matched by file hash).
+
+Sync runs automatically when the reader opens (pull) and exits (push + pull), silently and bounded to ~2s. `novel sync --off` disables it.
+
+---
+
+## Migrating from readshell-pro
+
 ```bash
-novel lang en                       # Set language (en / zh)
-novel config line-spacing 1         # Line spacing
-novel config reading-mode scroll    # scroll or page
-novel update                        # Update to latest
+npm uninstall -g readshell-pro && npm install -g readshell
 ```
 
+Your library, progress, and bookmarks are preserved — the data directory is unchanged. Cloud auth keys are cleaned up automatically on first run.
+
 ---
 
 ## Why the terminal?
@@ -103,13 +151,13 @@ The terminal is already where you live. It's focused, text-only, and distraction
 
 ReadShell doesn't ask you to context-switch. It sits quietly in your workflow — invisible to colleagues, zero install friction, no accounts, no cloud, no noise.
 
-Your reading history lives entirely on your local machine in a SQLite file. Nothing leaves your disk.
+Your reading history lives entirely on your local machine in a SQLite file (plus the sync folder you choose). Nothing leaves your disk otherwise.
 
 ---
 
 ## Tech Stack
 
-- **TypeScript** + **Node.js** ≥ 18
+- **TypeScript** + **Node.js** ≥ 20
 - **Ink** — React-based TUI framework
 - **SQLite** (`better-sqlite3`) — local-first, zero-dependency storage
 - **Vitest** — testing
@@ -119,8 +167,8 @@ Your reading history lives entirely on your local machine in a SQLite file. Noth
 src/
 ├── cli/        # Command layer
 ├── ui/         # TUI components (Ink)
-├── services/   # Business logic
-├── parsers/    # txt / epub parsers
+├── services/   # Business logic (incl. folder sync, stats)
+├── parsers/    # txt / epub / md parsers
 ├── db/         # SQLite layer
 ├── config/     # Config management
 └── utils/
@@ -130,11 +178,15 @@ src/
 
 ## Contributing
 
-Issues, ideas, and PRs are welcome.
+Issues, ideas, and PRs are welcome — see [CONTRIBUTING](docs/CONTRIBUTING.md).
 If ReadShell fits into your workflow, a ⭐ helps more people find it.
 
+## Sponsor
+
+If ReadShell saves you time, consider supporting development: https://readshell.com/sponsor
+
 ---
 
 ## License
 
-[AGPL-3.0](LICENSE)
+[MIT](LICENSE)