sinhala-words - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "sinhala-words",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A list of words in Sinhalese language for your autocompletion, spell-check and other use cases.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,24 @@
-# Sinhala-Words-List
-List of words in Sinhala language, offensive words, and a relative counter of their appearance in online sources (scraped and updated weekly) - @Ayesh
+Sinhala Words List
+==================
+
+A list of words in Sinhalese language, sorted by alphabetical order. Contains ~25,000 words.
+
+## Format
+The list of words is trimmed, and stored in a flat text file `si.txt`. Each word is separate by a new line character `\n`. 
+
+An additional `package.json` is provided to ease updating the list. 
+
+## Installation
+`npm install --save sinhala-words`
+
+## Usage
+For Node-based projects, you can use this words list by splitting the list of words by `\n` new line character. 
+```javascript
+const fs = require('fs');
+
+// Get path to the words list.
+onst sinhala_words_path= require('word-list');
+
+const sinhala_words= fs.readFileSync(sinhala_words_path, 'utf8').split('\n');
+// ['අභිචෝදකයා', 'අංකනය', 'අංකන', ...]
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

633435

increased by0.1%

Number of lines in readme file

24

increased by700%

No dependency changes