From f5b82febb2e446763f7b92f048c2ce631d78d951 Mon Sep 17 00:00:00 2001
From: Theo Chatzimichos <tampakrap@gmail.com>
Date: Mon, 7 Dec 2015 13:36:36 +0100
Subject: [PATCH] Add README.md

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f99e358
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+ra10ke
+======
+
+[![Gem Version](https://badge.fury.io/rb/ra10ke.svg)](https://badge.fury.io/rb/ra10ke)
+
+Rake tasks related to [R10K](https://github.com/puppetlabs/r10k) and
+[Puppetfile](https://github.com/puppetlabs/r10k/blob/master/doc/puppetfile.mkd).
+
+## Usage
+
+Simply add the following line in your `Gemfile`:
+
+```ruby
+require 'ra10ke'
+```
+
+## Rake tasks
+
+### r10k:syntax
+
+Syntax check for the Puppetfile. Similar to the `r10k puppetfile check`
+command.
+
+### r10k:dependencies
+
+This rake task goes through the modules that are declared in the Puppetfile,
+and prints outdated modules.
+
+#### Limitations
+
+  * It works only with modules from the [Forge](https://forge.puppetlabs.com).
+  Git and SVN modules will be ignored.
+  * The version has to be specified explicitly. If it is omitted, or it is
+  `:latest`, the module will be ignored.