Skip to content

Commit

Permalink
Update explanation in README ✍🏾
Browse files Browse the repository at this point in the history
  • Loading branch information
xaviervia committed Jan 17, 2017
1 parent f09f742 commit 7c198a1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ First install it:
npm install --save collect-fps
```

And simply call it with a callback:
Calling it will initialize the collection and return a function. When invoked, that function will stop the collection and return the frame per seconds value (a float number).

```javascript
import collectFPS from 'collect-fps'
Expand Down

0 comments on commit 7c198a1

Please sign in to comment.