# statman-stopwatch [![Build Status](https://travis-ci.org/jasonray/statman-stopwatch.svg?branch=master)](https://travis-ci.org/jasonray/statman-stopwatch)

# Please migrate!
This has been migrated to a metric package

github: `https://github.com/jasonray/statman`

npm: `statman`

```
var Stopwatch = require('statman').Stopwatch;
var stopwatch = new Stopwatch(true);
```

# statman-stopwatch [![Build Status](https://travis-ci.org/jasonray/statman-stopwatch.svg?branch=master)](https://travis-ci.org/jasonray/statman-stopwatch)

Simple high res stopwatch for node.js.  Stopwatch is useful for determining the amount of time it takes to perform an activity.


Use it!
=======

Basic usage
-----------
Create a new stopwatch, `start()` it, and later `read()` it
```
    var Stopwatch = require('statman-stopwatch');
    var sw = new Stopwatch();
    sw.start();

    // do some activity

    var delta = sw.read();
 ```

Autostart
---------
`start()` is too hard.  Create a new stopwatch with autostart=true, and later `read()` it
```
    var Stopwatch = require('statman-stopwatch');
    var sw = new Stopwatch(true);

    // do some activity

    var delta = sw.read();
 ```

Stop
----
Create a new stopwatch, `stop()` it, and later `read()` it
```
    var Stopwatch = require('statman-stopwatch');
    var sw = new Stopwatch(true);

    // do some activity

    sw.stop();

    // do some more activity

    //returns time associated with when stop() occurred
    var delta = sw.read();
 ```

Revert "update readme to encourage migration"
Revert "update readme to encourage migration"

This reverts commit 9299b21427102561d2b5be19cb170d3a21ccab35.

Restores readme to pre-migration
