update readme and packages.json

iamdual · iamdual · commit 33f30b8dc9b4 · 2023-04-06T00:55:17.000+03:00
diff --git a/README.md b/README.md
@@ -1,22 +1,27 @@
 # html2pdf
+
 An HTML to PDF converter provided by RESTful API and command-line tool. Powered by `puppeteer`.
 
 ## 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.
 
 ### Start server with Docker (recommended)
+
 ```bash
 docker run -p 3000:3000 iamdual/html2pdf
 ```
 
 ### Start server with source
+
 ```bash
 git clone https://github.com/iamdual/html2pdf && cd html2pdf
 npm install
 npm start
 ```
 
-### Example usage (JSON POST)
+### API request with POST JSON
+
 ```bash
 curl -X POST 'http://localhost:3000/generate' \
     --header 'Content-Type: application/json' \
@@ -27,13 +32,16 @@ curl -X POST 'http://localhost:3000/generate' \
     }' > google.pdf
 ```
 
-### Example usage (Query parameters)
+### API request with 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
@@ -42,8 +50,9 @@ html2pdf ./example.html --format A4 --pageRanges 1 -o example.pdf
 ```
 
 ## Parameters
+
 | Name       | Type    | Description                                                                                                                         |
-|------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
+| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
 | source     | string  | Set PDF document source. It must be specified. The source can be a URL or an HTML code.                                             |
 | timeout    | integer | Set connection timeout. Default is `10`.                                                                                            |
 | javascript | boolean | Enable JavaScripts. To enable, the value should be true. Disabled by default.                                                       |
@@ -57,4 +66,5 @@ html2pdf ./example.html --format A4 --pageRanges 1 -o example.pdf
 | 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`.      |
 
 ## Author
+
 Ekin Karadeniz (iamdual@icloud.com)
diff --git a/package.json b/package.json
@@ -5,7 +5,8 @@
   "main": "./src/index.js",
   "scripts": {
     "test": "npx tsc && mocha ./dist/test",
-    "start": "npx tsc && node ./dist/src/rest-api"
+    "start": "npx tsc && node ./dist/src/rest-api",
+    "clean": "rm -rf ./dist"
   },
   "bin": {
     "html2pdf": "./bin/index.js"
@@ -32,7 +33,7 @@
     "@types/jest": "^29.5.0"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.1",
-    "mocha": "^10.2.0"
+    "mocha": "^10.2.0",
+    "@types/mocha": "^10.0.1"
   }
 }
