Skip to content

Commit

Permalink
add a description section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua Hoblitt committed Oct 7, 2013
1 parent 3fca85b commit 5e7160b
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand All @@ -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).

Expand Down

0 comments on commit 5e7160b

Please sign in to comment.