mdict - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "mdict",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "node.js mdict (*.mdx, *.mdd) file reader",
@@ -20,3 +20,3 @@ "main": "index.js",
   ],
-  "author": "Jeka Kiselyov <[e-mail]> (http://www.jeka911.com/)",
+  "author": "Jeka Kiselyov <[e-mail]> (https://github.com/jeka-kiselyov)",
   "license": "MIT",
@@ -23,0 +23,0 @@ "bugs": {

README.md

@@ -1,2 +0,40 @@
-# mdict
+# node mdict
+
 node.js mdict (*.mdx, *.mdd) file reader
+
+Rude refactoring of https://github.com/fengdh/mdict-js to make it work on nodejs by [Jeka Kiselyov](https://github.com/jeka-kiselyov).
+Done enough to make it work for my project(with predefined dictionaries). It's tested with few .mdx files only, so there may be some bugs with other dictionaries. Please check and please feel free to submit pull requests with optimizations, unit tests etc.
+
+Released under terms of the MIT License, as original library.
+
+Installation:
+```bash
+npm install mdict
+```
+
+Usage:
+
+```javascript
+var mdict = require('mdict');
+  
+mdict.dictionary('dictionary.mdx').then(function(dictionary){
+		//// dictionary is loaded
+		dictionary.search({
+			phrase: 'دهخدا*', /// '*' and '?' supported
+			max: 10	          /// maximum results
+ 		}).then(function(foundWords){
+			console.log('Found words:');
+			console.log(foundWords);      /// foundWords is array
+
+			var word = ''+foundWords[0];
+			console.log('Loading definitions for: '+word);
+			return dictionary.lookup(word); /// typeof word === string
+		}).then(function(definitions){
+			console.log('definitions:');     /// definition is array
+			console.log(definitions);
+		});
+		
+	});
+```
+
+This is [on GitHub](https://github.com/jeka-kiselyov/mdict).

No alert changes

Improved metrics

Total package byte prevSize

72682

increased by1.74%

Number of lines in readme file

41

increased by1266.67%

No dependency changes