Skip to content

Commit ee0a746

Browse files
committed
docs: add npm installation instructions
1 parent c3edb13 commit ee0a746

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,27 @@ A lightweight, offline PDF parser that converts PDFs with native text into struc
44

55
Extract text, tables, columns, headings, lists, images, annotations, and document outlines while preserving references to the source content. The only required runtime dependency is `pdfjs-dist`. The optional `@napi-rs/canvas` dependency enables composite figure cropping; when unavailable, affected output is marked as degraded with a warning.
66

7-
## Build from source
7+
## Installation
88

99
Requires **Node.js 22.18 or later** and npm.
1010

11+
Install the library in your project:
12+
13+
```bash
14+
npm install pdf-lite-parse
15+
```
16+
17+
Or install the command-line tool globally:
18+
19+
```bash
20+
npm install -g pdf-lite-parse
21+
pdf-lite-parse document.pdf --out ./out --render
22+
```
23+
24+
## Build from source
25+
26+
From a checkout of this repository:
27+
1128
```bash
1229
npm ci
1330
npm run typecheck
@@ -56,10 +73,10 @@ Exit codes: `0` indicates completion, which may include degraded pages; `1` indi
5673

5774
## Node.js API
5875

59-
Install the generated package into your project:
76+
Install the package into your project:
6077

6178
```bash
62-
npm install /path/to/pdf-lite-parse-0.1.0.tgz
79+
npm install pdf-lite-parse
6380
```
6481

6582
Then import the API using ES modules:

0 commit comments

Comments
 (0)