Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
avoidwork committed Sep 7, 2015
1 parent 8dbd232 commit 5c80753
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ Harō indexes have the following structure `Map (field/property) > Map (value) >
searching, as well as inspection. Indexes can be managed independently of `del()` & `set()` operations, for example you
can lazily create new indexes via `reindex(field)`, or `sortBy(field)`.

### Requirements
Harō is built with ES6+ features, and requires polyfills for ES5 or earlier environments.

- `Map`
- `Set`
- `Promise`
- `fetch()`
- `deferred()` see [tiny-defer](https://github.com/avoidwork/tiny-defer) for loading in a browser
- `tuple()` see [tiny-tuple](https://github.com/avoidwork/tiny-tuple) for loading in a browser

### How to use
Harō takes two optional arguments, the first is an `Array` of records to set asynchronously, & the second is a
configuration descriptor.
Expand Down Expand Up @@ -785,14 +795,6 @@ store.batch(data, 'set').then(function (records) {
});
```

### Requirements
- `Map`
- `Promise`
- `Set`
- `fetch()`
- `deferred()` see [tiny-defer](https://github.com/avoidwork/tiny-defer) for loading in a browser
- `tuple()` see [tiny-tuple](https://github.com/avoidwork/tiny-tuple) for loading in a browser

## License
Copyright (c) 2015 Jason Mulligan
Licensed under the BSD-3 license

0 comments on commit 5c80753

Please sign in to comment.