From 5e7160b4e2312e9f43b6ed3282ec29e044c4cc22 Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Mon, 7 Oct 2013 15:58:18 -0700 Subject: [PATCH] add a description section to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b2dd618..23933af 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ Ruby rspec-nagios-formatter Gem [![Build Status](https://travis-ci.org/jhoblitt/rspec-nagios-formatter.png)](https://travis-ci.org/jhoblitt/rspec-nagios-formatter) + +Description +----------- + +This `gem` provides a simple [RSpec](http://rspec.info/) [custom formatter](https://www.relishapp.com/rspec/rspec-core/docs/formatters/custom-formatters) that reports `rspec` results in the Nagios/Icigna [plugin](http://docs.icinga.org/latest/en/pluginapi.html#outputspec) output format. + Install ------- @@ -15,11 +21,19 @@ Install bundle install bundle exec rake install + Usage ----- rspec -f RSpec::Nagios::Formatter +See the documentation on [rspec --format](https://www.relishapp.com/rspec/rspec-core/v/2-6/docs/command-line/format-option) +for more information. + + +Demo +---- + Demonstration of running this gem's `rspec` tests with it's own formatter (after it's been installed).