Skip to content

Commit cc817ed

Browse files
committed
Update readme
1 parent 3675257 commit cc817ed

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ from PDF files. It exposes a promise-based and an event-based API.
1616
- [Options](#options)
1717
- [Basic parsing](#basic-parsing)
1818
- [Advanced parsing](#advanced-parsing)
19+
- [Tests](#tests)
1920
- [Contributing](#contributing)
2021
- [License](#license)
2122

@@ -32,9 +33,9 @@ Let's be real. This might not be the library for you. Here are a few reasons why
3233
- **New to the game** - This library is brand new and haven't been battle tested yet. If you're looking for a reliable solution, this library might not be the best choice for you.
3334
- **No automated testing** - Though I'm working on this 🙃
3435

35-
## Minimal example
36+
## Examples
3637

37-
More examples can be found in the `examples` directory
38+
**Minimal example:**
3839

3940
```javascript
4041
const fs = require('fs');
@@ -49,6 +50,13 @@ parser.parse().then((result) => {
4950
});
5051
```
5152

53+
More examples can be found in the `examples` directory and can be run with the following commands:
54+
55+
```bash
56+
npm run example:events
57+
npm run example:promises
58+
```
59+
5260
## Installation
5361

5462
```bash
@@ -155,6 +163,14 @@ const result = await parser.parseRaw()
155163
}
156164
```
157165

166+
## Tests
167+
168+
Tests can be run with with the following commands:
169+
```bash
170+
npm run build
171+
npm run test
172+
```
173+
158174
## Contributing
159175

160176
Contributions and PRs are very welcome! PRs should go towards the `develop` branch.

0 commit comments

Comments
 (0)