Skip to content

Commit 3114548

Browse files
committed
Organize API docs into sections. Closes #3
1 parent 2a58168 commit 3114548

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,12 @@ This library is designed to work with [reactive-property](https://github.com/dat
8282
var ReactiveProperty = require("reactive-property");
8383
```
8484

85-
## API Documentation
85+
## API Reference
86+
87+
* [Managing Reactive Functions](#managing-reactive-functions)
88+
* [Data Flow Execution](#data-flow-execution)
89+
90+
### Managing Reactive Functions
8691

8792
<a name="constructor" href="#constructor">#</a> <b>ReactiveFunction</b>(<i>options</i>)
8893

@@ -111,6 +116,8 @@ Input properties for one reactive function may also be outputs of another.
111116

112117
Cleans up resources allocated to this reactive function and removes listeners from inputs.
113118

119+
### Data Flow Execution
120+
114121
<a name="digest" href="#digest">#</a> ReactiveFunction.<b>digest</b>()
115122

116123
Propagates changes from input properties through the data flow graph defined by all reactive properties using [topological sorting](https://en.wikipedia.org/wiki/Topological_sorting). An edge in the data flow graph corresponds to a case where the output of one reactive function is used as an input to another.
@@ -127,6 +134,7 @@ This is a simple polyfill for [requestAnimationFrame](https://developer.mozilla.
127134

128135
## Related Work
129136

137+
* [Functional Reactive Animation (academic paper)](https://www.eecs.northwestern.edu/~robby/courses/395-495-2009-winter/fran.pdf)
130138
* [ReactiveJS](https://github.com/mattbaker/Reactive.js)
131139
* [vogievetsky/DVL](https://github.com/vogievetsky/DVL)
132140
* [EmberJS Computed Properties](https://guides.emberjs.com/v2.0.0/object-model/computed-properties/)

0 commit comments

Comments
 (0)