epub-to-pdf-cli 1.1.2 → 1.1.4

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.
Files changed (2) hide show
  1. package/README.md +51 -9
  2. package/package.json +13 -2
package/README.md CHANGED
@@ -3,23 +3,34 @@
3
3
  ![license](https://img.shields.io/npm/l/epub-to-pdf-cli)
4
4
  ![node](https://img.shields.io/node/v/epub-to-pdf-cli)
5
5
 
6
- # 📘 EPUB to PDF CLI – Convert EPUB files to PDF using Calibre.
6
+ # # 📘 EPUB to PDF CLI – Node.js EPUB to PDF Converter using Calibre
7
7
 
8
- A simple and reliable **EPUB → PDF converter** using **Calibre**.
9
- Works as both a **CLI tool** and a **Node.js library**.
8
+
9
+ **epub-to-pdf-cli** is a fast and reliable **Node.js command-line tool** to convert **EPUB files to PDF** using **Calibre**.
10
+
11
+ It supports CLI usage, automation scripts, CI pipelines, and programmatic Node.js integration.
12
+
13
+
14
+ This tool is ideal for:
15
+
16
+ - Developers
17
+ - Automation pipelines
18
+ - Ebook processing
19
+ - Batch EPUB to PDF conversion
10
20
 
11
21
  ---
12
22
 
13
23
  ## ✨ Features
14
24
 
15
25
  - Convert EPUB to PDF using Calibre
16
- - CLI and programmatic API
26
+ - Simple CLI (epub2pdf)
27
+ - Programmatic Node.js API
17
28
  - Cross-platform (Linux, macOS, Windows)
18
- - Lightweight, no bundled binaries
19
- - Clear error messages
29
+ - No bundled binaries (uses system Calibre)
30
+ - Lightweight and fast
31
+ - Clear error handling
20
32
 
21
33
  ---
22
-
23
34
  ## 📦 Installation
24
35
 
25
36
  ### Global install (CLI)
@@ -27,6 +38,7 @@ Works as both a **CLI tool** and a **Node.js library**.
27
38
  ```bash
28
39
  npm install -g epub-to-pdf-cli
29
40
  ```
41
+ After installation, the epub2pdf command will be available globally.
30
42
 
31
43
  ## Or run without installing
32
44
  ```bash
@@ -41,6 +53,7 @@ Examples
41
53
  epub2pdf mybook.epub
42
54
  epub2pdf mybook.epub mybook.pdf
43
55
  ```
56
+ This converts an EPUB ebook file into a PDF document using Calibre.
44
57
 
45
58
  ## 📚 Programmatic Usage
46
59
  ### bash
@@ -53,10 +66,11 @@ import { convertEpubToPdf } from 'epub-to-pdf-cli';
53
66
 
54
67
  await convertEpubToPdf('book.epub', 'book.pdf');
55
68
  ```
69
+ This makes the package suitable for **Node.js scripts, backend services**, and **automation workflows**.
56
70
 
57
71
  ## ⚙ Requirements
58
72
 
59
- This package requires Calibre to be installed.
73
+ This package **requires Calibre** to be installed.
60
74
 
61
75
  Verify installation:
62
76
  ### bash
@@ -78,11 +92,39 @@ brew install calibre
78
92
  Download from: https://calibre-ebook.com/download
79
93
  ```
80
94
 
81
- ## ❌ Common Errors
95
+ ## ❌ Common Errors & Solutions
82
96
 
83
97
  ebook-convert not found
98
+
84
99
  → Install Calibre and ensure it is in PATH.
85
100
 
101
+ **Cause**: Calibre is not installed or not in PATH
102
+
103
+ **Solution**: Install Calibre and restart your terminal
104
+
105
+ → Input EPUB file does not exist
106
+
107
+ **Cause**: Invalid file path
108
+
109
+ **Solution**: Check the EPUB file path and permissions
110
+
111
+ ## 🔖 Versioning & Breaking Changes
112
+
113
+ This project follows **Semantic Versioning** using **Conventional Commits**.
114
+
115
+ ### Commit Types
116
+ - `fix:` → Patch release
117
+ - `feat:` → Minor release
118
+ - `feat!:` → Major release (breaking change)
119
+
120
+ ### Breaking Changes
121
+ Any change that breaks existing usage **must** be marked as a breaking change.
122
+
123
+ Example:
124
+ ```bash
125
+ git commit -m "feat!: change CLI input format"
126
+ ```
127
+
86
128
  ## 📄 License
87
129
 
88
130
  MIT © Suraj Sutar
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "epub-to-pdf-cli",
3
- "version": "1.1.2",
3
+ "version": "1.1.4",
4
4
  "description": "CLI tool to convert EPUB to PDF using Calibre. Works with npx and global install.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -22,7 +22,18 @@
22
22
  "calibre",
23
23
  "ebook-convert",
24
24
  "cli",
25
- "npx"
25
+ "npx",
26
+ "epub to pdf",
27
+ "epub pdf converter",
28
+ "epub to pdf cli",
29
+ "node epub to pdf",
30
+ "calibre epub",
31
+ "ebook converter",
32
+ "ebook epub pdf",
33
+ "epub pdf linux",
34
+ "epub pdf mac",
35
+ "epub pdf windows",
36
+ "epub cli tool"
26
37
  ],
27
38
  "author": "Suraj Sutar",
28
39
  "license": "MIT",