Example README template

gistfile1.txt

Description
===========

A brief description of the purpose of this cookbook, the problem it solves, etc.

Requirements
============

Requirements for using this cookbook. Chef version can be noted if significant.

## Platforms

List only platforms the cookbook has actually been tested on. Also list them in `supports` in the metadata. If particular versions are required, mention them.

## Cookboooks

List cookbook dependencies here, and they should also be in the metadata. If particular versions are required mention them.

Attributes
==========

Notation should be in the form of `node['cookbook_name']['attribute']` for completeness and clarity.

Recipes
=======

Give an overview of what each recipe is supposed to do if it isn't totally obvious from looking at it. Particularly if search and dynamic data massaging is done before any resources. List multiple recipes if relevant.

default
-------

Resources/Providers
===================

Document the cookbook's resources and their providers here. Follow a format that can easily be translated to confluence markup for wiki use.

Usage
=====

Document usage about the cookbook. If it needs special roles or data bags, discuss them. Extended or complex examples should use the section below.

Examples
--------

Changes/Roadmap
==============

Keep track of version changes in this section. Use the git commit messages and the COOK ticket numbers.

## v 0.0.0

License and Author
==================

Author:: AUTHOR_NAME

Copyright:: YYYY, COMPANY_NAME

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.