Skip to content

Commit 8b38f4a

Browse files
committed
made an initial readme
1 parent fad3aeb commit 8b38f4a

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
angular-fibonacci
1+
Angular Fibonacci
22
=================
33

4-
Add a Fibonacci interval to your Angular project.
4+
Do you need to poll data from your server but you don't want to poll with a fixed interval? Angular Fibonacci is here to help!
5+
6+
##What is Angular Fibonacci?
7+
Angular Fibonacci is a tiny AngularJS Service that lets you poll your server using timeouts according to the [Fibonacci series](http://en.wikipedia.org/wiki/Fibonacci_number). Instead of polling every, say 5, seconds, with Angular Fibonacci, you can poll in 2, 3, 5, 8, 13, ... second intervals! Also, whenever you detect a change in the data you polled, you can simply call ```Fibonacci.restart()``` to restart the series. So if you think your environment can benefit from Fibonacci-polling, use Angular Fibonacci!
8+
9+
##Installation
10+
* Download the file manually from GitHub or use [Bower](http://bower.io/):
11+
12+
```bower install fibonacci-angular```
13+
14+
* Make sure you add a reference to the Fibonacci service:
15+

0 commit comments

Comments
 (0)