Skip to content

Commit

Permalink
New fancy markdown README, ditch old busted RDoc README.
Browse files Browse the repository at this point in the history
  • Loading branch information
leftathome committed May 8, 2013
1 parent 4cad730 commit df015db
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 19 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# chef-rundeck
[![Gem Version](https://badge.fury.io/rb/chef-rundeck.png)](http://badge.fury.io/rb/chef-rundeck)
[![Build Status](https://secure.travis-ci.org/oswaldlabs/chef-rundeck.png?branch=master)](http://travis-ci.org/oswaldlabs/chef-rundeck)
[![Dependency Status](https://gemnasium.com/oswaldlabs/chef-rundeck.png?travis)](https://gemnasium.com/oswaldlabs/chef-rundeck)
[![Code Climate](https://codeclimate.com/github/oswaldlabs/chef-rundeck.png)](https://codeclimate.com/github/oswaldlabs/chef-rundeck)

A simple Sinatra app that presents matching node results of a Chef search formatted as a RunDeck resource list.

## Usage

Install the gem and fire up chef-rundeck. Point it at a Chef client config file (a knife config would be ideal) and provide the URI for your Chef server's web UI.

## Configuration Notes

More to come.

## Notes on Patches/Pull Requests

We want your cool additional feature. Here's how to give it to us:

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. *THIS IS IMPORTANT* as it ensures no one else will break your feature accidentally somewhere down the line.
* If you're adding a feature, please also add documentation.
* *Exception:* Please don't change the Rakefile, version or history files!
* Commit your changes and push them to your GitHub repo. Bonus points for committing your changes to a named topic branch ("awesome_new_feature" > "master")
* Send us a pull request through the GitHub UI.

# Copyright

Original code © 2010 Adam Jacob. Released to the open source community under the Apache license in 2013. See the LICENSE file for details.
19 changes: 0 additions & 19 deletions README.rdoc

This file was deleted.

0 comments on commit df015db

Please sign in to comment.