summaryrefslogtreecommitdiffstats
path: root/cookbooks/aai-resources/aai-resources-auth/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cookbooks/aai-resources/aai-resources-auth/README.md')
-rw-r--r--cookbooks/aai-resources/aai-resources-auth/README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/cookbooks/aai-resources/aai-resources-auth/README.md b/cookbooks/aai-resources/aai-resources-auth/README.md
new file mode 100644
index 0000000..b5157ab
--- /dev/null
+++ b/cookbooks/aai-resources/aai-resources-auth/README.md
@@ -0,0 +1,68 @@
+aai-resources-auth Cookbook
+======================
+TODO: Enter the cookbook description here.
+
+e.g.
+This cookbook makes your favorite breakfast sandwich.
+
+Requirements
+------------
+TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+
+e.g.
+#### packages
+- `toaster` - ajsc-aai-auth needs toaster to brown your bagel.
+
+Attributes
+----------
+TODO: List your cookbook attributes here.
+
+e.g.
+#### ajsc-aai-auth::default
+<table>
+ <tr>
+ <th>Key</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ <tr>
+ <td><tt>['ajsc-aai-auth']['bacon']</tt></td>
+ <td>Boolean</td>
+ <td>whether to include bacon</td>
+ <td><tt>true</tt></td>
+ </tr>
+</table>
+
+Usage
+-----
+#### aai-resources-auth::default
+TODO: Write usage instructions for each cookbook.
+
+e.g.
+Just include `aai-resources-auth` in your node's `run_list`:
+
+```json
+{
+ "name":"my_node",
+ "run_list": [
+ "recipe[ajsc-aai-auth]"
+ ]
+}
+```
+
+Contributing
+------------
+TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
+
+e.g.
+1. Fork the repository on Github
+2. Create a named feature branch (like `add_component_x`)
+3. Write your change
+4. Write tests for your change (if applicable)
+5. Run the tests, ensuring they all pass
+6. Submit a Pull Request using Github
+
+License and Authors
+-------------------
+Authors: TODO: List authors