Merge pull request #22 from adrienv1520/fix/doc

fix/doc

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.2.1 - delivery @17/01/2020
+
+- update Readme
+
 ## 1.2.0 - delivery @15/01/2020
 
 - add opacity and bgOpacity options

README.md

@@ -10,6 +10,12 @@
 - [Presentation](#presentation)
 - [Bitgener Online Demo](#bitgener-online-demo)
 - [Installation](#installation)
+- [Technical information](#technical-information)
+  - [Node.js](#node.js)
+  - [Debugging](#debugging)
+  - [Tests](#tests)
+    - [Linting](#linting)
+    - [Unit](#unit)
 - [Supported symbologies](#supported-symbologies)
 - [Usage](#usage)
   - [Library](#library)
@@ -20,13 +26,9 @@
       - [2D barcode](#2d-barcode)
       - [Full example using Sharp](#full-example-using-sharp)
   - [Environment variables](#environment-variables)
-  - [Error codes](#error-codes)
-- [Technical information](#technical-information)
-  - [Node.js](#node.js)
-  - [Debugging](#debugging)
-  - [Tests](#tests)
-    - [Linting](#linting)
-    - [Unit](#unit)
+  - [Errors](#errors)
+    - [Object structure](#object-structure)
+    - [Codes](#codes)
 - [Development](#development)
 - [Licence](#licence)
 
@@ -50,6 +52,37 @@ The aim of this project is to provide a simple, lightweight, zero-depency and fa
 
 `npm install bitgener`
 
+`npm i -S bitgener`
+
+# Technical information
+
+## Node.js
+
+- Language: JavaScript ES6/ES7
+- VM: Node.js >=10.0.0
+
+## Debugging
+
+- Own debugger embedded that writes on *process.stderr* when the *DEBUG* environment variable is set. See [Environment variables](#environment-variables).
+
+## Tests
+
+Command to run all tests:
+
+`npm test`
+
+### Linting
+
+ESLint with Airbnb base rules. See [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
+
+`npm run test:lint`
+
+### Unit
+
+Mocha and Chai.
+
+`npm run test:unit`
+
 # Supported symbologies
 
 One dimension:
@@ -377,7 +410,7 @@ const convert = async function convert({
   - `DEBUG=bitgener*` will debug all Bitgener modules that could use the debugger.
   - `DEBUG=*` will debug all Bitgener modules that could use the debugger plus other modules used in your project if they use an equivalent debugger.
 
-## Error
+## Errors
 
 ### Object structure
 
@@ -482,36 +515,6 @@ Errors emitted by Bitgener inherit the native Error prototype.
   </tr>
 </table>
 
-
-# Technical information
-
-## Node.js
-
-- Language: JavaScript ES6/ES7
-- VM: NodeJS v10.0.0 and higher
-
-## Debugging
-
-- Own debugger embedded that writes on *process.stderr* when the *DEBUG* environment variable is set.
-
-## Tests
-
-Command to run all tests:
-
-`npm test`
-
-### Linting
-
-ESLint with Airbnb base rules.
-
-`npm run test:lint`
-
-### Unit
-
-Mocha and Chai.
-
-`npm run test:unit`
-
 # Development
 
 All contributions are greatly welcomed :)

package.json

@@ -1,8 +1,8 @@
 {
   "name": "bitgener",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A lightweight and zero-dependencies pure Node.js barcode library",
-  "author": "Adrien Valcke",
+  "author": "Adrien Valcke <[email protected]> (https://github.com/adrienv1520)",
   "main": "lib/index.js",
   "private": false,
   "preferGlobal": false,