Skip to content

Commit 37030c5

Browse files
committed
doc: fix instructions for execution of tests
1 parent 2f19dcb commit 37030c5

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,26 @@ Summary:
2020

2121
## Installation, tests and CLI usage
2222

23+
After installing [Node.js](https://nodejs.org/):
24+
2325
```sh
24-
nvm use # optional, to switch to the recommended version of Node.js
25-
npm install pdfreader
26-
cd node_modules/pdfreader
26+
git clone https://github.com/adrienjoly/npm-pdfreader.git
27+
cd npm-pdfreader
28+
npm install
2729
npm test
2830
node parse.js test/sample.pdf
2931
```
3032

33+
## Installation into an existing project
34+
35+
To install `pdfreader` as a dependency of your Node.js project:
36+
37+
```sh
38+
npm install pdfreader
39+
```
40+
41+
Then, see below for examples of use.
42+
3143
## Raw PDF reading
3244

3345
This module exposes the `PdfReader` class, to be instantiated. You can pass `{ debug: true }` to the constructor, in order to log debugging information. (useful for troubleshooting)

0 commit comments

Comments
 (0)