Skip to content

Commit

Permalink
minor
Browse files Browse the repository at this point in the history
  • Loading branch information
anayjoshi committed Jul 5, 2014
1 parent 2f72b5e commit 3b52e01
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
![Cronus](/docs/_static/cronus-extended-logo.png?raw=true "Cronus Logo")

Cronus is a collection of utilities to force timing restrictions on computation in Python

## Install

```
pip install cronus
```

or

```
git clone http://github.com/anayjoshi/cronus
python setup.py install
```

## Usage

As of now, Cronus implements two features:

* Allows a continuous while loop to run at fixed frequency
* Allows a continuous while loop to run at a fixed frequency

```python
import cronus.beat as beat
Expand All @@ -29,7 +38,7 @@ if __name__ == "__main__":
print datetime.datetime.now()
```

* Implements a @timeout decorator to forcefully timeout an external function
* Implements a `@timeout` decorator to forcefully timeout a function call

```python
import time
Expand Down

0 comments on commit 3b52e01

Please sign in to comment.