ean-validator 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +18 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ean-validator",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Validator for Belgium EAN numbers",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/readme.md ADDED
@@ -0,0 +1,18 @@
1
+ # EAN validator
2
+
3
+ Simple Belgium EAN validator to check if an energy or electricity meter is valid
4
+
5
+ ## Installation
6
+
7
+ ```sh
8
+ npm i ean-validator
9
+ ```
10
+
11
+ ## Usage
12
+ ```sh
13
+ const eanValidator = require('ean-validator');
14
+ 'or'
15
+ import eanValidator from 'ean-validator';
16
+
17
+ eanValidator.isValid('541449200002202157'); // true or false
18
+ ```