Skip to content

Commit 6a02503

Browse files
committed
Update README
1 parent 6e51e41 commit 6a02503

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ Licensed under the MIT license:
1111
http://www.opensource.org/licenses/MIT
1212

1313
## Overview
14-
Observable Slim is a singleton that utilizes ES6 Proxies to observe changes made to an object
15-
and any nested children of that object. It is intended to assist with state management and one-way
16-
data binding. Observable Slim aspires to be as lightweight and simple as possible. Minifies
17-
down to roughly 3000 characters.
14+
Observable Slim is a singleton that utilizes ES6 Proxies to observe changes made to an object and any nested children of that object. Observable Slim aspires to be as highly performant and lightweight as possible. Minifies down to 5KB.
15+
16+
Observable Slim was originally built as part of the **[Nimbly](https://github.com/elliotnb/nimbly)** JS framework where it assists with state management, state mutation triggers and one-way data binding. Observerable Slim was separated out from Nimbly in order to serve use cases outside of the scope of the **[Nimbly](https://github.com/elliotnb/nimbly)** framework.
1817

1918
## Install
2019

@@ -33,8 +32,7 @@ $ npm install observable-slim --save
3332

3433
### Create an observer
3534

36-
The `create` method is the starting point for using Observable Slim. It is invoked to create a new ES6 Proxy
37-
whose changes we can observe. The `create` method accepts three parameters:
35+
The `create` method is the starting point for using Observable Slim. It is invoked to create a new ES6 Proxy whose changes we can observe. The `create` method accepts three parameters:
3836

3937
1. `target` - Object, required, plain JavaScript object that we want to observe for changes.
4038
2. `domDelay` - Boolean, required, if true, then Observable Slim will batch up observed changes to `target` on a 10ms delay (via `setTimeout`). If false, then `observer` will be immediately invoked after each individual change made to `target`. It is helpful to set `domDelay` to `true` when your `observer` function makes DOM manipulations (fewer DOM redraws means better performance).

0 commit comments

Comments
 (0)