Skip to content

Commit

Permalink
adds a very basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
meodai committed Jan 26, 2015
1 parent 82fd571 commit 059cd57
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,26 @@ ticktack.js
=============

requestanimationframe based watch.

## Installation

```
bower install ticktack.js
```

### Usage

```javascript
ticktack.on('second', function(e,o){
console.log(e,o);
// e contains all the values relative to seconds
// o contains values for all digits
});
```


```javascript
ticktack.on('tick', function(e,o){
// will be called on requestAnimationFrame
});
```

0 comments on commit 059cd57

Please sign in to comment.