Browse files

Update README.

  • Loading branch information...
1 parent c0a82df commit 2979ea2011705ed534788a2579c047da32eb2cd6 @twe4ked committed Aug 18, 2012
Showing with 29 additions and 2 deletions.
  1. +29 −2 README.md
View
31 README.md
@@ -1,4 +1,31 @@
RSpec Notification Center
--------------------------
+=========================
-Specify multiple formatters: `rspec spec/lib --format=doc --format=Nc`.
+rspec-nc is an RSpec formatter for Mountain Lion's Notification Center.
+
+Installation
+------------
+
+Installing rspec-nc is easy. Just put it in your Gemfile (`gem 'rspec-nc'`) and
+run your specs like this from now on:
+
+```
+$ rspec --format=doc --format=Nc
+```
+
+You will want to specify another formatter as rspec-nc does not provide any
+other output.
+
+If you want to use rspec-nc as your default formatter, simply put this option
+in your .rspec file:
+
+```
+--format Nc
+```
+
+Contributing
+------------
+
+Found an issue? Have a great idea? Want to help? Great! Create an issue issue
+for it, or even better; fork the project and fix the problem yourself. Pull
+requests are always welcome. :)

0 comments on commit 2979ea2

Please sign in to comment.