omelette - npm Package Compare versions

Comparing version 0.4.2 to 0.4.4

package.json

@@ -11,3 +11,3 @@ {
   "author": "Fatih Kadir Akın <[e-mail]>",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "licenses": [
@@ -14,0 +14,0 @@ {

README.md

@@ -144,6 +144,17 @@ <img src="https://rawgit.com/f/omelette/master/resources/logo.svg?v1" height="80">
 
-### Install
+### Tree API 🌲
 
-#### Automated Install
+You can use `simple objects` as autocompletion definitions:
 
+```javascript
+omelette('hello').tree({
+  cruel: ['world', 'moon'],
+  beautiful: ['mars', 'pluto']
+}).init();
+```
+
+## Install
+
+### Automated Install
+
 Installing, and making your users install the autocompletion feature is very simple.
@@ -167,3 +178,3 @@
 
-#### Manual Install
+### Manual Install
 
@@ -249,3 +260,6 @@ *(You should add these instructions to your project's README)*
     is: {
-      your: ['house', 'car'],
+      // You can also add some logic with defining functions:
+      your() {
+        return ['house', 'car'];
+      },
     }
@@ -262,2 +276,10 @@ },
 
+#### Advanced Tree Implementations
+
+You can seperate your autocompletion by importing objects from another file:
+
+```js
+omelette('hello').tree(require('./autocompletion-tree.js')).init();
+```
+
 ### Short Names
@@ -264,0 +286,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1479724

increased by0.03%

Number of lines in readme file

360

increased by6.51%

No dependency changes