Commit cbf829de3c92ce641590e320ffd3f2fb07a3cf61
update readme for v1.0
mmckegg/loop-drop-app#173Matt McKegg committed on 7/28/2016, 2:47:24 AM
Parent: 5be33c01238870a66c608fed4ece3fbc43069a51
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -4,16 +4,27 @@ | ||
| 4 | 4 | Create observables and map them to DOM elements. Massively inspired by `hyperscript` and `observ-*`. |
| 5 | 5 | |
| 6 | 6 | No virtual dom, just direct observable bindings. Unnecessary garbage collection is avoided by using mutable objects instead of blasting immutable junk all over the place. |
| 7 | 7 | |
| 8 | -## Current Status: Experimental / Unpublished | |
| 8 | +## Current Status: Experimental / Maintained | |
| 9 | 9 | |
| 10 | +Expect breaking changes. | |
| 11 | + | |
| 12 | +Being used as primary renderer and data models in [Loop Drop](https://github.com/mmckegg/loop-drop-app). | |
| 13 | + | |
| 10 | 14 | ## Install |
| 11 | 15 | |
| 12 | 16 | ```bash |
| 13 | 17 | npm install @mmckegg/mutant --save |
| 14 | 18 | ``` |
| 15 | 19 | |
| 20 | +## Compatibility | |
| 21 | + | |
| 22 | +Requires an environment that supports: | |
| 23 | + - `Map` and `WeakMap` | |
| 24 | + - `MutationObserver` (optional, only for root `html-element` binding support) | |
| 25 | + - ES5 arrays | |
| 26 | + | |
| 16 | 27 | ## Use |
| 17 | 28 | |
| 18 | 29 | ```js |
| 19 | 30 | var h = require('@mmckegg/mutant/html-element') |
Built with git-ssb-web