diff --git a/CHANGELOG.md b/CHANGELOG.md
index ce8e13c..99afdd9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,13 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+### [1.0.1](https://github.com/mokkapps/changelog-generator-demo/compare/v1.0.0...v1.0.1) (2022-03-21)
+
+
+### Documentation
+
+* update readme ([5a09c3f](https://github.com/mokkapps/changelog-generator-demo/commits/5a09c3f204f34cd3da39d090b3634d2da9e2304c))
+
## [1.0.0](https://github.com/bsorrentino/pdf-tools/compare/v0.5.2...v1.0.0) (2022-03-21)
* refactor: upgrade pdf-dist version, build on nodejs 16 and test also on macos M1 ([91952e2](https://github.com/bsorrentino/pdf-tools/commit/91952e262b189185068c2fe8e3bf46de942ca811))
diff --git a/README.md b/README.md
index 04bb82c..55a017b 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,27 @@
+[![npm](https://img.shields.io/npm/v/@bsorrentino/pdf-tools.svg)](https://www.npmjs.com/package/@bsorrentino/pdf-tools)
+
+
+
+
+![example workflow](https://github.com/bsorrentino/pdf-tools/actions/workflows/npm-publish.yml/badge.svg)
+
# pdf-tools
Tools to extract/transform data from PDF
> inspired by project: [pdf-to-markdown](https://github.com/jzillmann/pdf-to-markdown)
+## Installation
+
+```
+npm install pdf-tools -g
+```
+
+## Requirements
+
+* NodeJs >= 16
+* Since **pdf-tools** use [`canvas`] that is a [`Cairo`]-backed Canvas implementation for Node.js take a look to its [reqirements]
+
## pdftools Commands
@@ -59,7 +77,10 @@ pdftools pdf2md|p2md [options]
* Detect code block ( i.e. ` ``` `)
* Detect external link
-### to do
+### TO DO
+
+* Detect TOC
-* Detect table
-* Detect TOC
\ No newline at end of file
+[`canvas`]: https://www.npmjs.com/package/canvas
+[`Cairo`]: http://cairographics.org/
+[reqirements]: https://github.com/Automattic/node-canvas#compiling
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index d0f5e00..bd073c2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "@bsorrentino/pdf-tools",
- "version": "1.0.0",
+ "version": "1.0.1",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@bsorrentino/pdf-tools",
- "version": "1.0.0",
+ "version": "1.0.1",
"license": "MIT",
"dependencies": {
"canvas": "^2.9.1",
diff --git a/package.json b/package.json
index f880a99..1659012 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@bsorrentino/pdf-tools",
- "version": "1.0.0",
+ "version": "1.0.1",
"description": "",
"main": "index.js",
"bin": {
@@ -46,17 +46,44 @@
"tag": true
},
"types": [
- {"type": "feat", "section": "Features"},
- {"type": "fix", "section": "Bug Fixes"},
- {"type": "chore", "hidden": true},
- {"type": "docs", "section": "Documentation"},
- {"type": "style", "hidden": true},
- {"type": "refactor", "section": "Refactoring"},
- {"type": "perf", "hidden": true},
- {"type": "test", "hidden": true},
- {"type": "build", "section": "Build"}
- ],
- "commitUrlFormat": "https://github.com/mokkapps/changelog-generator-demo/commits/{{hash}}",
- "compareUrlFormat": "https://github.com/mokkapps/changelog-generator-demo/compare/{{previousTag}}...{{currentTag}}"
- }
+ {
+ "type": "feat",
+ "section": "Features"
+ },
+ {
+ "type": "fix",
+ "section": "Bug Fixes"
+ },
+ {
+ "type": "chore",
+ "hidden": true
+ },
+ {
+ "type": "docs",
+ "section": "Documentation"
+ },
+ {
+ "type": "style",
+ "hidden": true
+ },
+ {
+ "type": "refactor",
+ "section": "Refactoring"
+ },
+ {
+ "type": "perf",
+ "hidden": true
+ },
+ {
+ "type": "test",
+ "hidden": true
+ },
+ {
+ "type": "build",
+ "section": "Build"
+ }
+ ],
+ "commitUrlFormat": "https://github.com/mokkapps/changelog-generator-demo/commits/{{hash}}",
+ "compareUrlFormat": "https://github.com/mokkapps/changelog-generator-demo/compare/{{previousTag}}...{{currentTag}}"
+ }
}