Dictionaty added

Readme updated index.js created
solovets · Dec 27, 2017 · af00430 · af00430
1 parent 468e5fd
commit af00430
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,28 @@
 # russian-words
-Returns an array of Russian words (97 206 items)
+Returns an array of Russian words (106 057 items)
+
+### Install
+
+```
+npm i russian-words --save
+```
+
+### Usage
+
+``` javascript
+const words = require('russain-words');
+
+console.log(words[0]); // returns "абажур"
+```
+
+### Encoding
+UTF8
+
+### Change log
+| Version | Changes |  
+|---------|---------------------|
+| 1.0.0   | 106 057 items added |
+
+
+### License
+UNLICENSED
diff --git a/index.js b/index.js
@@ -0,0 +1,3 @@
+const words = require('./words.json');
+
+module.exports = words;
diff --git a/package.json b/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "russian-words",
+  "version": "1.0.0",
+  "description": "Returns an array of Russian words (97 035 items)",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solovets/russian-words.git"
+  },
+  "keywords": [
+    "russian",
+    "words",
+    "dictionary"
+  ],
+  "author": "Denis Solovets",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/solovets/russian-words/issues"
+  },
+  "homepage": "https://github.com/solovets/russian-words#readme"
+}
diff --git a/words.json b/words.json
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const words = require('./words.json');

		module.exports = words;