Added operators description to the readme

.travis.yml

@@ -1,6 +1,8 @@
 language: node_js
 
 node_js:
+  - "8"
+  - "7"
   - "6.2"
   - "6.3"
   - "6.4"

README.md

@@ -1,6 +1,89 @@
 # ioo - Immutable Object Operators
 [![NPM version](https://img.shields.io/npm/v/ioo.svg)](https://www.npmjs.com/package/ioo)
-[![Build Status](https://travis-ci.org/DxCx/ioo.svg?branch=master)](https://travis-ci.org/DxCx/ioo)
-[![Coverage Status](https://coveralls.io/repos/github/DxCx/ioo/badge.svg?branch=master)](https://coveralls.io/github/DxCx/ioo?branch=master)
+[![Build Status](https://travis-ci.org/this-dot/ioo.svg?branch=master)](https://travis-ci.org/this-dot/ioo)
+[![Coverage Status](https://coveralls.io/repos/github/this-dot/ioo/badge.svg?branch=master)](https://coveralls.io/github/this-dot/ioo?branch=master)
 [![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
 
+# Installation
+
+```sh
+npm install --save ioo
+```
+
+# Operations
+
+## mapObject(object, ( key: string, value: any ) => any): {}
+
+Iterate over keys of the object and invoke the callback for every key, passing the key and value on that key. The callback signature is meant to be similar to `Array.prototype.map`. Value returned from the callback will become the new value on that key.
+
+```ts
+mapObject({ firstName: 'peter', lastName: 'griffin' }, ( key, value ) => value.toUpperCase() )
+// => { firstName: 'Peter', lastName: 'Griffin' }
+```
+
+For more code examples, checkout [src/mapObject.test.ts](src/mapObject.test.ts)
+
+## reduceObject(object, ( result: any, key: string, value: any ) => any, initial: any ): any
+
+Reduce the object to a single value. The result can be another object. The callback signature is meant to be similar to `Array.prototype.reduce`. This operator will invoke the callback for each property. The callback will receive the result of previous operation or initial value, the key and value at that property. 
+
+```ts
+reduceObject({ firstName: 'peter', lastName: 'griffin' }, ( result, key, value ) => {
+  if (result) {
+    return `${result} ${value}`;
+  } else {
+    return value;
+  }
+}, null);
+// => peter griffin
+
+reduceObject({ firstName: 'peter', lastName: 'griffin' }, ( result, key, value ) => {
+  return {
+    ...result,
+    [key.toLowerCase()]: value
+  };
+}, {});
+// =>  { firstname: 'peter', lastname: 'griffin' }
+```
+
+For more code examples, checkout [src/reduceObject.test.ts](src/reduceObject.test.ts)
+
+## filterObject(object, ( key: string, value: any ) => {} ): {}
+
+Iterate the keys of the object and invoke the callback for each key and value pair. If the callback returns a truthy value then
+the key will be included in the output object. The callback signature is meant to be similar to `Array.prototype.filter`.
+
+```ts
+filterObject({ firstName: 'peter', lastName: 'griffin', age: 62 }, ( key, value ) => {
+  return typeof value === 'string';
+});
+// => { firstName: 'peter', lastName: 'griffin' }
+```
+
+For more code examples, checkout [src/filterObject.test.ts](src/filterObject.test.ts)
+
+## set(path: Array<string | number>, value: any, data: Array | {}): Array | {}
+
+`set` operator will create a new object with value replaced at given path. It uses lenses from [Ramda.js](http://ramdajs.com/docs/#set) to ensure that all objects that are parents to the object that received the value become new objects as well. This is particularly helpful in frameworks like React and Glimmer.js that compare state by reference. The path can mix objects and arrays. Use integer for array keys and strings for object keys.
+
+```ts
+set([ 'a', 0, 'b' ], 'e', { a: [ { b: 'c' }, { b: 'd' } ]});
+//=> { a: [ { b: 'e' } , { b: 'd' } ] }
+```
+
+For more code examples, checkout [src/set.test.ts](src/set.test.ts)
+
+## get(path: Array<string | number>, data: Array | {}): any
+
+`get` counterpart to `set`. It accepts a path array of strings or integers and returns value found that path. 
+
+```ts
+set([ 'a', 0, 'b' ], { a: [ { b: 'c' }, { b: 'd' } ]});
+//=> c
+```
+
+For more code examples, checkout [src/get.test.ts](src/get.test.ts)
+
+# Credit
+
+Big thanks to [Charles Lowell](http://github.com/cowboyd) who wrote the map/reduceObject functions and showed me how to use lenses.

src/index.ts

@@ -1 +1,8 @@
-export { Example } from "./Example";
+import get from './get';
+import set from './set';
+import reduceObject from './reduceObject';
+import mapObject from './mapObject';
+import filterObject from './filterObject';
+import eachProperty from './eachProperty';
+
+export { eachProperty, filterObject, mapObject, reduceObject, set, get };