update readme and version

iamdual · iamdual · commit 60bfa61b5d69 · 2023-03-30T02:01:25.000+03:00
diff --git a/README.md b/README.md
@@ -1,9 +1,22 @@
 # html2pdf
 An HTML to PDF converter provided by RESTful API and command-line tool. Powered by `puppeteer`.
 
-## Usage
+## RESTful API
+The best reason to use this method is that we can use it on any programming languages and software that support HTTP requests.
 
-### RESTful API
+### Start server with npm
+```bash
+git clone https://github.com/iamdual/html2pdf
+npm install --production
+npm start
+```
+
+### Start server with Docker
+```bash
+docker run -p 3000:3000 iamdual/html2pdf
+```
+
+### Example usage (JSON POST)
 ```bash
 curl -X POST 'http://localhost:3000/generate' \
     --header 'Content-Type: application/json' \
@@ -14,11 +27,18 @@ curl -X POST 'http://localhost:3000/generate' \
     }' > google.pdf
 ```
 
-### Command-line
+### Example usage (Query parameters)
+```bash
+curl 'http://localhost:3000/generate?source=https://google.com&timeout=10' > google.pdf
+```
+
+## Command-line tool
+It also support for command-line interface, so you can convert easily to a PDF.
 ```bash
 npm install -g https://github.com/iamdual/html2pdf
 html2pdf '<!DOCTYPE html><strong>Hello world!</strong>' -o output.pdf
 html2pdf "https://www.google.com" --format A4 --timeout 10 -o google.pdf
+html2pdf ./example.html --format A4 --pageRanges 1 -o example.pdf
 ```
 
 ## Parameters
@@ -32,7 +52,7 @@ html2pdf "https://www.google.com" --format A4 --timeout 10 -o google.pdf
 | format     | string  | Set paper format. Must be one of `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `Letter`, `Legal`, `Tabloid`, `Ledger`. Default is `A4`. |
 | width      | integer | Set PDF document width. Both height and width must be used together. It will disable `format` option.                               |
 | height     | integer | Set PDF document height. Both height and width must be used together. It will disable `format` option.                              |
-| scale      | float   | Set scale. The value must be greater than or equals to `0.1`, or lower then or equals to `2`. Default is `1`.                       |
+| scale      | float   | Set scale. The value must be greater than or equals to `0.1`, or lower than or equals to `2`. Default is `1`.                       |
 | landscape  | boolean | Enable landscape mode. To enable, the value should be true. Disabled by default.                                                    |
 | margin     | string  | Set margin(s) for the PDF document. It can be all four margin or specified by the values separated with space. Default is `0`.      |
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@iamdual/html2pdf",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "HTML to PDF converter",
   "main": "./src/index.js",
   "scripts": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@iamdual/html2pdf",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.2.0",`
`4`	`4`	`"description": "HTML to PDF converter",`
`5`	`5`	`"main": "./src/index.js",`
`6`	`6`	`"scripts": {`