readr-cli 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -0
- package/package.json +8 -2
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# 📚 readr-cli
|
|
2
|
+
|
|
3
|
+
A beautiful terminal tool to track your reading sessions, speed, and estimated completion time.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g readr-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
reading add # Add a new book
|
|
15
|
+
reading start # Start a reading session
|
|
16
|
+
reading pause # Pause or resume current session
|
|
17
|
+
reading stop # End session & log pages read
|
|
18
|
+
reading list # All books with progress & ETA
|
|
19
|
+
reading stats # Overall reading statistics
|
|
20
|
+
reading help # Show help
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Features
|
|
24
|
+
|
|
25
|
+
- 📊 **Progress bars** — visual % complete for every book
|
|
26
|
+
- ⚡ **Reading speed** — calculated from your real sessions (pages/hr)
|
|
27
|
+
- 🕐 **ETA** — estimated time to finish based on your personal speed
|
|
28
|
+
- ⏸ **Pause/resume** — break time is excluded from speed calculations
|
|
29
|
+
- 💾 **Persistent data** — stored locally in `~/.reading-cli/data.json`
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
📖 The Beginning After The End by TurtleMe
|
|
35
|
+
[██████░░░░░░░░░░░░░░░░░░░░░░░░] 20.6%
|
|
36
|
+
Page: 247 / 1200 Sessions: 3 Time: 4h 12m
|
|
37
|
+
Speed: 33.2 pages/hr ETA: 28h 43m left
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Requirements
|
|
41
|
+
|
|
42
|
+
Node.js 18 or higher.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "readr-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Beautiful CLI to track reading sessions, speed, and book completion ETA",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -17,7 +17,13 @@
|
|
|
17
17
|
"engines": {
|
|
18
18
|
"node": ">=18"
|
|
19
19
|
},
|
|
20
|
-
"keywords": [
|
|
20
|
+
"keywords": [
|
|
21
|
+
"reading",
|
|
22
|
+
"tracker",
|
|
23
|
+
"cli",
|
|
24
|
+
"books",
|
|
25
|
+
"progress"
|
|
26
|
+
],
|
|
21
27
|
"license": "MIT",
|
|
22
28
|
"dependencies": {
|
|
23
29
|
"chalk": "^5.3.0",
|