es6-fuzz 6.0.8 → 6.0.9

package/Readme.md

@@ -1,107 +1,96 @@
-# es6-fuzz 
+# es6-fuzz
 
-> Fuzzy Logic in Javascript
+> Fuzzy Logic in JavaScript
 
 [![npm](https://img.shields.io/npm/dt/es6-fuzz.svg)](https://www.npmjs.com/package/es6-fuzz)
 [![license](https://img.shields.io/github/license/sebs/es6-fuzz.svg)](https://github.com/sebs/es6-fuzz/blob/master/LICENSE.md)
 [![GitHub tag](https://img.shields.io/github/tag/sebs/es6-fuzz.svg)](https://github.com/sebs/es6-fuzz)
 [![GitHub issues](https://img.shields.io/github/issues/sebs/es6-fuzz.svg)](https://github.com/sebs/es6-fuzz/issues)
 
-## Supported fuzzyfiers
+## Supported Fuzzifiers
 
-* Constant
-* Grade
-* Reverse Grade
-* Sigmoid
-* Trapezoid
-* Triangle
+* **Constant** - Fixed membership value
+* **Grade** - Linear membership function
+* **Reverse Grade** - Inverted linear membership
+* **Sigmoid** - S-shaped membership curve
+* **Trapezoid** - Trapezoidal membership function
+* **Triangle** - Triangular membership function
 
-* [api docs](http://sebs.github.io/es6-fuzz)
-* [changelog](https://github.com/sebs/es6-fuzz/blob/master/docs/CHANGELOG.md)
+## Documentation
 
-## Install and Usage
+* [API Documentation](http://sebs.github.io/es6-fuzz)
+* [Changelog](https://github.com/sebs/es6-fuzz/blob/master/docs/CHANGELOG.md)
 
-es6-fuzz is available as a NPM package.
+## Installation
 
-```
+```bash
 npm install es6-fuzz
 ```
-## Example
+
+## Quick Start
 
 ```javascript
-var logic = new Logic();
-var res = logic
+const { Logic, Triangle, Trapezoid, Grade } = require('es6-fuzz');
+
+const logic = new Logic();
+const result = logic
   .init('noAttack', new Triangle(0, 20, 40))
   .or('normalAttack', new Trapezoid(20, 30, 90, 100))
   .or('enragedAttack', new Grade(90, 100))
-	.defuzzify(40);
+  .defuzzify(40);
+
+console.log(result); // 'enragedAttack'
 ```
-* enraged attack
 
-## Example 2
+## Temperature Example
 
 <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/61/Fuzzy_logic_temperature_en.svg/300px-Fuzzy_logic_temperature_en.svg.png" />
 
 ```javascript
-var Trapezoid = require('./lib/curve/trapezoid');
+const { Logic, Trapezoid } = require('es6-fuzz');
 
-var logic = new Logic();
-var res = logic
+const logic = new Logic();
+const result = logic
   .init('cold', new Trapezoid(0, 12, 18, 20))   
   .or('hot', new Trapezoid(12, 14, 16, 100)) 
   .defuzzify(20);
 
+console.log(result); // 'hot'
 ```
 
-* hot
-
-
-## Usage with boon-js
-
-In order to combine 2 fuzzy functions with boolean logic, there is a compat layer for boon-js which allows the sauge of 'boolean expression language'. 
-
-Example of a monster biting when its cold and you are close to it: 
- 
 
-Heat part:
+## Advanced Usage with boon-js
 
-```js
-var logicHeat = new Logic();
-const optimalTemperature = new Triangle(10, 20, 30);
-const toColdTemperature = new Triangle(0, 10, 15);
-const toHotTemperature = new Triangle(25, 40, 60);
+Combine multiple fuzzy functions with boolean logic using the boon-js compatibility layer.
 
-logicHeat.init('cold', toColdTemperature)
-logicHeat.or('optimal', optimalTemperature)
-logicHeat.or('hot', toHotTemperature);
-```
-
-Distance Part
+### Example: Monster AI
 
-```js
+A monster that bites when it's cold AND you're close to it:
 
-var logicDistance = new Logic();
-const close = new Triangle(0, 10, 20);
-const far = new Triangle(5, 50, 100);
+```javascript
+const { Logic, Triangle } = require('es6-fuzz');
+const { getEvaluator } = require('boon-js');
 
-logicDistance.init('close', close)
-logicDistance.or('far', far)
+// Temperature logic
+const logicHeat = new Logic();
+logicHeat.init('cold', new Triangle(0, 10, 15))
+  .or('optimal', new Triangle(10, 20, 30))
+  .or('hot', new Triangle(25, 40, 60));
 
-```
+// Distance logic  
+const logicDistance = new Logic();
+logicDistance.init('close', new Triangle(0, 10, 20))
+  .or('far', new Triangle(5, 50, 100));
 
-Now we marry the 2 and use boon js
+// Combine with boolean logic
+const monsterBiteTest = getEvaluator('heat.cold AND distance.close');
 
-```js
-const monsterBiteTest = getEvaluator(
-    'heat.cold AND distance.close',
-);
 const resHeat = logicHeat.defuzzify(2, 'heat');
 const resClose = logicDistance.defuzzify(2, 'distance');
 
-const jsBoonInput = { ...resHeat.boonJsInputs, ...resClose.boonJsInputs }
+const jsBoonInput = { ...resHeat.boonJsInputs, ...resClose.boonJsInputs };
 
-monsterBiteTest(jsBoonInput) 
-// returns true
+console.log(monsterBiteTest(jsBoonInput)); // true
 ```
 
     
@@ -110,24 +99,30 @@ monsterBiteTest(jsBoonInput)
 
 
 
-## development
+## Development
 
-**Tests** use node internal testing framework
+### Running Tests
 
-```
+```bash
 npm test
 ```
 
-* docs: npm run docs, npm run docs:site
+### Building Documentation
+
+```bash
+npm run docs        # Generate API docs
+npm run docs:site   # Build documentation site
+```
+
+## Requirements
 
-# Stuff
-* http://de.slideshare.net/BCSLeicester/fuzzy-logic-in-the-real-world-2326817
-* http://computing.dcu.ie/~humphrys/Notes/Neural/sigmoid.html
+* Node.js 20+
 
-## Supported Node.js Versions
+## Resources
 
-Versions: 20+
+* [Fuzzy Logic in the Real World](http://de.slideshare.net/BCSLeicester/fuzzy-logic-in-the-real-world-2326817)
+* [Understanding Sigmoid Functions](http://computing.dcu.ie/~humphrys/Notes/Neural/sigmoid.html)
 
-## Related
+## Related Projects
 
-* https://www.npmjs.com/package/gaussian
+* [gaussian](https://www.npmjs.com/package/gaussian) - Gaussian distribution functions

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es6-fuzz",
   "description": "fuzzy logic with and for es6",
-  "version": "6.0.8",
+  "version": "6.0.9",
   "main": "lib/logic.js",
   "repository": "git@github.com:sebs/es6-fuzz.git",
   "homepage": "https://github.com/sebs/es6-fuzz",