cookbooks/00cookbook/README.md

   1 # 00cookbook Cookbook
   2
   3 TODO: Enter the cookbook description here.
   4
   5 e.g.
   6 This cookbook makes your favorite breakfast sandwich.
   7
   8 ## Requirements
   9
  10 TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
  11
  12 e.g.
  13 ### Platforms
  14
  15 - SandwichOS
  16
  17 ### Chef
  18
  19 - Chef 12.0 or later
  20
  21 ### Cookbooks
  22
  23 - `toaster` - 00cookbook needs toaster to brown your bagel.
  24
  25 ## Attributes
  26
  27 TODO: List your cookbook attributes here.
  28
  29 e.g.
  30 ### 00cookbook::default
  31
  32 <table>
  33   <tr>
  34     <th>Key</th>
  35     <th>Type</th>
  36     <th>Description</th>
  37     <th>Default</th>
  38   </tr>
  39   <tr>
  40     <td><tt>['00cookbook']['bacon']</tt></td>
  41     <td>Boolean</td>
  42     <td>whether to include bacon</td>
  43     <td><tt>true</tt></td>
  44   </tr>
  45 </table>
  46
  47 ## Usage
  48
  49 ### 00cookbook::default
  50
  51 TODO: Write usage instructions for each cookbook.
  52
  53 e.g.
  54 Just include `00cookbook` in your node's `run_list`:
  55
  56 ```json
  57 {
  58   "name":"my_node",
  59   "run_list": [
  60     "recipe[00cookbook]"
  61   ]
  62 }
  63 ```
  64
  65 ## Contributing
  66
  67 TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
  68
  69 e.g.
  70 1. Fork the repository on Github
  71 2. Create a named feature branch (like `add_component_x`)
  72 3. Write your change
  73 4. Write tests for your change (if applicable)
  74 5. Run the tests, ensuring they all pass
  75 6. Submit a Pull Request using Github
  76
  77 ## License and Authors
  78
  79 Authors: TODO: List authors
  80