readme: getting started

== Getting Started

This will listen for json-events with type=unicorn_seen and render a timeline-plot showing the number of received events per hour.

Copy doc/ulm_stats.rb (that's the configuration from the screenshots and screencast) or the simple example from below to 'my_stats_app.rb'

Simple Example: This will listen for json-events with type=unicorn_seen and render a timeline-plot showing the number of received events per hour.

 require "fnordmetric"

  FnordMetric.standalone

Start the app (requires ruby >= 1.9.2):

  $ ruby my_stats_app.rb run

Log all incoming events:

  $ ruby my_stats_app.rb log

This is the easiest way to submit an event:

  echo "{'_type': 'unicorn_seen'}\n" | nc localhost 1337

== Installation

here be dragons

  gem install fnordmetric

== Configuration

or in your Gemfile:

here be dragons

  gem 'fnordmetric', '>= 0.5.1'

== Documentation