-*- mode: markdown; mode: auto-fill; fill-column: 80 -*-

# <%= config[:name].gsub(/.*-/, '').capitalize %> Puppet Module 

[![Puppet Forge](http://img.shields.io/puppetforge/v/<%= config[:name].gsub(/-/,"/") %>.svg)](<%= config[:forge_url] %>)
[![License](http://img.shields.io/:license-<%= config[:license].gsub(/-/, '') %>-blue.svg)](LICENSE)
![Supported Platforms](http://img.shields.io/badge/platform-<%= config[:platforms].join('|') %>-lightgrey.svg)

<%= config[:summary] %>


      Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
      

* [Online Project Page](<%= config[:project_page] %>)  -- [Sources](<%= config[:source] %>) -- [Issues](<%= config[:issues_url] %>)

## Synopsis

<%= config[:description] %>

The various operations of this repository are piloted from a `Rakefile` which
assumes that you have [RVM](https://rvm.io/) installed on your system.

## Dependencies

See `metadata.json`.

## <%= config[:name].gsub(/.*-/, '') %> class parameters

* `$ensure` [Default: 'present']: Ensure <%= config[:name].gsub(/^puppet-/,'')
  %> is present, absent etc. 

## Usage

### class <%= config[:name].gsub(/.*-/, '') %>

     include '<%= config[:name].gsub(/.*-/,'') %>'


## Documentation

Please refer to the header of each manifest files to understand the usage of
classes and definitions associated to the '<%= config[:name] %>' module.
 
Alternatively, generate automatically the documentation via
[`puppet doc`](http://docs.puppetlabs.com/man/doc.html) as follows:  

       $> rake doc   # Not yet implemented
       
For other information, please refer to the `metadata.json` file in this directory 

## Librarian-Puppet / R10K Setup

You can of course configure <%= config[:name] %> in your `Puppetfile` to make it 
available with [Librarian puppet](http://librarian-puppet.com/) or
[r10k](https://github.com/adrienthebo/r10k) by adding the following entry:

     mod <%= config[:name] %>, 
         :git => <%= config[:source] %>,
         :ref => <%= FalkorLib.config[:gitflow][:branches][:master] %> 


## Issues / Feature request

You can submit bug / issues / feature request using the 
[<%= config[:name] %> Tracker](<%= config[:issues_url] %>). 


## Developments / Contributing to the code 

If you want to contribute to the code, you shall be aware of the way this module
is organized.
These elements are detailed on [`doc/contributing.md`](doc/contributing.md)

You are more than welcome to contribute to its development by 
[sending a pull request](https://help.github.com/articles/using-pull-requests). 

## Resources

### Git 

You should become familiar (if not yet) with Git. Consider these resources: 

* [Git book](http://book.git-scm.com/index.html)
* [Github:help](http://help.github.com/mac-set-up-git/)
* [Git reference](http://gitref.org/)