first commit

Author: solkimicreb

.gitignore

@@ -57,3 +57,5 @@ typings/
 # dotenv environment variables file
 .env
 
+# reify cache for allowing import export in node
+.reify-cache

README.md

@@ -1,2 +1,65 @@
-# react-easy-state
-A small observer library that replaces React.setState with direct mutations. (WIP)
+# React Easy State
+
+Easy State aims to make React's state management simpler without adding new syntax. To achieve this it makes the following modifications.
+
+- It replaces React's `setState()` with plain native JavaScript.
+- It bypasses the asynchronity and performance issues of `setState`.
+- It auto binds your component's methods.
+
+## Installation
+
+`npm i react-easy-state --save`
+
+## Usage
+
+```js
+import React, { Component } from 'react'
+import easyState from 'react-easy-state'
+
+@easyState
+export default class App extends Component {
+  render() {
+    const { name } = this.state
+
+    return (
+      <div>
+        <div>Name: <input onChange={this.updateName}/></div>
+        <p>Hello {name}!</p>
+      </div>
+    )
+  }
+
+  updateName (ev) {
+    this.state.name = ev.target.value
+  }
+}
+```
+
+You can find more examples with live demos [here](/examples).
+
+### About decorators
+
+`@easyState` is a decorator, which is not yet part of the JS language. You can learn how to enable decorators with babel [here](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) or you can use the older `export default easyState(Comp)` syntax.
+
+## Platform support
+
+- Node: 6 and above
+- Chrome: 49 and above
+- Firefox: 38 and above
+- Safari: 10 and above
+- Edge: 12 and above
+- Opera: 36 and above
+- React native is not yet supported
+- IE is not supported
+
+## How does it work?
+
+Under the hood it uses the [@nx-js/observer-util](https://github.com/nx-js/observer-util) library, which relies on ES6 proxies to observe state changes. Thanks to the Proxies it doesn't have edge cases or limitations. You can write any JS code without worrying about the render function. [This blog post](https://blog.risingstack.com/writing-a-javascript-framework-data-binding-es6-proxy/) gives a little sneak peek under the hood of the `observer-util`.
+
+## Contributing
+
+Contributions are always welcome. Just send a PR against the master branch or open a new issue. Please make sure that the tests and the linter pass and the coverage remains at 100%. Thx!
+
+## The NX Framework
+
+This library is the side effect of a front-end framework I have been working on in the past year. Please take a look at the [NX Framework](https://nx-framework.com/) if you have some time. Have a nice day!