From 9c2fa3bcba48aa1fa14e3b0786145d2c14fa77bc Mon Sep 17 00:00:00 2001 From: Luke Venediger Date: Mon, 22 Apr 2013 02:01:51 +0300 Subject: [PATCH 1/3] Added some project info. --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d806e63..dc5fe28 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A simple c# client library for [statsd.net](https://github.com/lukevenediger/statsd.net/) and [statsd](https://github.com/etsy/statsd/). -## Features +# Features * Log counts, timings and gauges * Has an additional API that uses dynamics to create and submit stats * Fault-tolerant client that can be configured to fail silently (with a warning) if misconfigured @@ -15,8 +15,14 @@ A simple c# client library for [statsd.net](https://github.com/lukevenediger/sta * batch-and-pump - collecting stats and sending them out in a batch at regular intervals * Output to an HTTP endpoint -## Quickstart -Assuming your statsd.net server is running on localhost and listening on port 12000: +# Installation via Nuget +Install the StatsdCsharpClient via nuget: +```bash +PM> Install-Package StatsdCsharpClient +``` + +# Quickstart +Assuming your server is running on localhost and listening on port 12000: ```csharp var statsd = new StatsdClient("localhost", 12000); // Log a count @@ -46,4 +52,17 @@ statsd.count.site.hits += 1; statsd.gauge.site.activeUsers += numActiveUsers; // Log a timing statsd.site.pageLoad += 100; /* milliseconds */ -``` \ No newline at end of file +``` + +# Project Information + +## Target Runtimes +* .Net 4.5 + +## Authors +Luke Venediger - lukev@lukev.net + +## See Also +* [statsd.net](https://github.com/lukevenediger/statsd.net/) +* [statsd](https://github.com/etsy/statsd) +* [graphite](https://github.com/graphite-project) From fe2ad512ebd11a94200b60f3b81ea94476145ac4 Mon Sep 17 00:00:00 2001 From: Luke Venediger Date: Mon, 22 Apr 2013 02:03:22 +0300 Subject: [PATCH 2/3] Added link to nuget package. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc5fe28..748abfa 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ A simple c# client library for [statsd.net](https://github.com/lukevenediger/sta * Output to an HTTP endpoint # Installation via Nuget -Install the StatsdCsharpClient via nuget: +Install the [StatsdCsharpClient](https://nuget.org/packages/StatsdCsharpClient/) via nuget: ```bash PM> Install-Package StatsdCsharpClient ``` @@ -66,3 +66,4 @@ Luke Venediger - lukev@lukev.net * [statsd.net](https://github.com/lukevenediger/statsd.net/) * [statsd](https://github.com/etsy/statsd) * [graphite](https://github.com/graphite-project) +* [StatsdCsharpClient on nuget.org](https://nuget.org/packages/StatsdCsharpClient/) From 24d7a1db5c48b4ee1016ceb0fcc10e64b79a42bf Mon Sep 17 00:00:00 2001 From: Luke Venediger Date: Mon, 22 Apr 2013 02:04:17 +0300 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 748abfa..6e40754 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A simple c# client library for [statsd.net](https://github.com/lukevenediger/sta * Allows for customisation of every output stat to do things like screen metrics before sending * Supports a user-defined prefix to prepend to every metric -## Coming soon +Coming soon: * Support for sets and count sampling * batch-and-pump - collecting stats and sending them out in a batch at regular intervals * Output to an HTTP endpoint