Merge pull request #11 from JuanMaRuiz/fix/readme

Fix/readme
JuanMaRuiz · Sep 7, 2021 · 52ac368 · 52ac368
2 parents 7bd4f6f + f2d72c1
commit 52ac368
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.0.1] - 2020-09-07
+### Fix documentation
+* Fix "How to use" section in README
+
 ## [1.0.0] - 2020-09-06
 ### Convert to esm module
 * Package converted to esm module

diff --git a/README.md b/README.md
@@ -15,6 +15,21 @@ npm i personal-document-generator --save-dev
 
 ## Usage
 
+
+**Version v1.0.0**
+
+```bash
+import { getValidDNI, generateValidNIE } from 'personal-document-generator';
+
+getValidDNI();
+//=> '30292557Q'
+
+getValidNIE();
+//=> 'Z5247524X'
+```
+
+**Version v0.1.6**
+
 ```bash
 const { getValidDNI, generateValidNIE } = require('personal-document-generator');
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "personal-document-generator",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "type": "module",
   "main": "index.js",