chef-partners/cookbook-guide-generator

View on GitHub
cookbooks/code_generator/templates/default/README.md.erb

Summary

Maintainability
Test Coverage
# <%= cookbook_name %>

TODO: Enter a one line description of the cookbook here.

## SCOPE

TODO: Enter a description of the scope of this cookbook. If you
need an example, the [mysql](https://github.com/chef-cookbooks/mysql) cookbook
is a good place to start.

## Requirements

TODO: Enter any requirements for the cookbook.

## Dependencies

TODO: Enter any other cookbooks or ruby libraries for this cookbook.

## Usage

TODO: Enter specific usage instructions for this cookbook.

## Testing

For more details look at the [TESTING.md](./TESTING.md).

TODO: Enter any specific instructions for Testing this cookbook.

## Resources

TODO: Document any [Custom Resources](https://docs.chef.io/custom_resources.html) that this cookbook may provide.

## License & Authors

If you would like to see the detailed LICENCE click [here](./LICENCE).

- Author:: <%= copyright_holder %> <<%= email %>>

```text
Copyright:: <%= copyright_holder %>

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.
```