Add the README

README.md

@@ -0,0 +1,81 @@
+Remote debugging for MobX with [Redux DevTools extension](https://github.com/zalmoxisus/redux-devtools-extension) (and [remotedev](https://github.com/zalmoxisus/remotedev) coming soon) 
+
+![Demo](demo.gif) 
+
+## Installation
+
+#### 1. Get the extension
+##### 1.1 For Chrome
+ - from [Chrome Web Store](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
+ - or build it with `npm i & npm run build:extension` and [load the extension's folder](https://developer.chrome.com/extensions/getstarted#unpacked) `./build/extension`
+ - or run it in dev mode with `npm i & npm start` and [load the extension's folder](https://developer.chrome.com/extensions/getstarted#unpacked) `./dev`.
+
+##### 1.2 For Firefox
+ - from [AMO](https://addons.mozilla.org/en-US/firefox/addon/remotedev/)
+ - or build it with `npm i & npm run build:firefox` and [load the extension's folder](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) `./build/firefox`.
+
+##### 1.3 For Electron
+  - just specify `REDUX_DEVTOOLS` in [`electron-devtools-installer`](https://github.com/GPMDP/electron-devtools-installer).
+
+##### 1.4 For other browsers, for React Native, hybrid, desktop and server side apps
+  - [Coming...](https://github.com/zalmoxisus/mobx-remotedev/issues/1)
+
+#### 2. Install the library
+
+```
+npm install --save mobx-remotedev
+```
+
+## Usage
+
+```js
+import remotedev from 'mobx-remotedev';
+// or import remotedev from 'mobx-remotedev/lib/dev'
+// in case you want to use it in production or don't have process.env.NODE_ENV === 'development'
+
+const appStore = observable({
+  // ...
+});
+
+// Or
+class appStore {
+	// ...
+}
+
+export default remotedev(appStore);
+```
+
+See [counter](https://github.com/zalmoxisus/mobx-remotedev/blob/master/examples/counter/stores/appState.js) and [todomvc](https://github.com/zalmoxisus/mobx-remotedev/tree/master/examples/todomvc/src/stores) examples.
+
+## API
+#### `remotedev(store, [config])`
+  - arguments
+    - **store** *observable or class* to be monitored. In case you want to change its values (to time travel or cancel actions), you should export its result as in the example above (so we can extend the class). 
+    - **config** *object* (optional as the parameters bellow)
+      - **name** *string* - the instance name to be showed on the monitor page. Default value is document.title.
+      - **shouldStringify** *boolean* - set it to `true` when having circular references or special types like ImmutableJS. By default is `false`.
+
+Also see [the extension API](https://github.com/zalmoxisus/redux-devtools-extension#documentation) and [my presentation at React Europe](https://youtu.be/YU8jQ2HtqH4).
+
+## Exclude / include DevTools in production builds
+
+By default use
+```js
+import remotedev from 'mobx-remotedev';
+```
+
+It will work only when `process.env.NODE_ENV === 'development'`, otherwise the code will be stripped.
+
+In case you want to use it in production or cannot set `process.env.NODE_ENV`, use
+```js
+import remotedev from 'mobx-remotedev/lib/dev';
+```
+So, the code will not be stripped from production bundle and you can use the extension even in production. It wouldn't affect the performance for end-users who don't have the extension installed. 
+
+## LICENSE
+
+[MIT](LICENSE)
+
+## Created By
+
+If you like this, follow [@mdiordiev](https://twitter.com/mdiordiev) on twitter.