Skip to content

Commit 047c057

Browse files
author
pemrouz
committed
docs: update readme
1 parent d173735 commit 047c057

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,23 @@
22
[![Coverage Status](https://coveralls.io/repos/rijs/data/badge.svg?branch=master&service=github)](https://coveralls.io/github/rijs/data?branch=master)
33
[![Build Status](https://travis-ci.org/rijs/data.svg)](https://travis-ci.org/rijs/data)
44

5-
Allows registering data resources (objects or arrays).
5+
Extends [core](https://github.com/rijs/core#ripple--core) to register objects and arrays. It also enables per-resource change listeners on those resources, as well versioning info.
66

77
```js
88
ripple('data', [])
99
```
1010

11-
All data resources will be emitterified:
11+
All data resources will be [emitterified](https://github.com/utilise/utilise#--emitterify):
1212

1313
```js
14-
ripple('data').on('change', fn)
15-
ripple('data').once('change', fn)
16-
ripple('data').emit('change')
14+
// instead of: ripple.on('change', function(name, change){ .. })
15+
ripple('name').on('change', function(change){ .. })
16+
ripple('name').once('change', function(change){ .. })
17+
ripple('name').emit('change')
18+
```
19+
20+
All data resources will be initialised with [versioning info](https://github.com/utilise/utilise#--set):
21+
22+
```js
23+
ripple('name').log
1724
```

0 commit comments

Comments
 (0)