Skip to content

Commit

Permalink
Added LICENSE + updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Pracucci committed Mar 26, 2015
1 parent c190f3c commit 2277af8
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 33 deletions.
13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright (c) 2015, Spreaker <[email protected]>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
60 changes: 28 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,53 @@
# Node.js Statsd Client


## How to install
### How to install

npm install node-statsd-client
``` bask
npm install node-statsd-client
```


## How it works
### How it works

var Client = require('node-statsd-client').Client;

var client = new Client("localhost", 8192);
``` js
var Client = require('node-statsd-client').Client;

// Count stat
client.count("num_logged_users", 1);
client.increment("num_logged_users");
client.decrement("num_logged_users");

// Timing stat
client.timing("request_ms", 250);

// Gauge stat
client.gauge("gauge_stats", 4);
var client = new Client("localhost", 8192);

// Count stat
client.count("num_logged_users", 1);
client.increment("num_logged_users");
client.decrement("num_logged_users");

## History
// Timing stat
client.timing("request_ms", 250);

### 1.0.2 / 2013-0117
* Removed unnecessary "underscore" dependency (thanks to omega)
// Gauge stat
client.gauge("gauge_stats", 4);
```


### 1.0.1 / 2012-06-21

* Fixed global leak of Client (thanks to sreuter)
### Changes

#### 1.0.3 (2015-03-26)
* Added LICENSE (BSD)
* Updated README

#### 1.0.2 (2013-01-17)
* Removed unnecessary "underscore" dependency (thanks to omega)

### 1.0.0 / 2012-06-07
#### 1.0.1 (2012-06-21)
* Fixed global leak of Client (thanks to sreuter)

#### 1.0.0 (2012-06-07)
* This is the 3rd statsd client for node.js. I don't like to re-invent the wheel and
I must admint it's really a bad thing. However, I need a simple but working statsd
client and it seems that (at the time of writing) the other modules suffer small
bugs that prevent me to put it in production. Now you know cause there're 3 modules
for such a simple client.


## Contributors
### Contributors

* [sreuter](https://github.com/sreuter)


## Whishlist

* Testing
* Add sampling support
* Log errors: stderr or logger? max logs/minute?
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-statsd-client",
"version": "1.0.2",
"version": "1.0.3",
"description": "Statsd client for node.js",
"keywords": ["statsd", "client"],
"repository": "https://github.com/spreaker/nodejs-statsd-client.git",
Expand Down

0 comments on commit 2277af8

Please sign in to comment.