From df015dbd7771c331e76898c30e90102868793f28 Mon Sep 17 00:00:00 2001 From: Steven Wagner Date: Wed, 8 May 2013 12:12:13 -0700 Subject: [PATCH] New fancy markdown README, ditch old busted RDoc README. --- README.md | 31 +++++++++++++++++++++++++++++++ README.rdoc | 19 ------------------- 2 files changed, 31 insertions(+), 19 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee1a4eb --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index bbc73fa..0000000 --- a/README.rdoc +++ /dev/null @@ -1,19 +0,0 @@ -= chef-rundeck - -Integrates Chef with RunDeck. - -Install the gem and fire up chef-rundeck - point it at a Chef Client configuration file (the one you use for knife would be ideal), and provide the URI for your Chef Server Web UI. - -== Note on Patches/Pull Requests - -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. - -== Copyright - -Copyright (c) 2010 Adam Jacob. See LICENSE for details.