summaryrefslogtreecommitdiffstats
path: root/cookbooks/ajsc-aai-auth/README.md
diff options
context:
space:
mode:
authorSteve Smokowski <ss835w@att.com>2017-02-09 15:38:13 -0500
committerSteve Smokowski <ss835w@att.com>2017-02-09 15:39:00 -0500
commitb160c3cc1e58e85502ccaa7358cd38ff210ed34a (patch)
tree210cc985eff4dc146e3ea431cdc7d1e792594314 /cookbooks/ajsc-aai-auth/README.md
parent7a3f850cf5c4aad118edaaf0b6981352daecb2a8 (diff)
Initial OpenECOMP A&AI commitrelease-1.0.0
Change-Id: Ic953856ef5e44eebf05bd00fe26cb5901fb49289 Signed-off-by: Steve Smokowski <ss835w@att.com>
Diffstat (limited to 'cookbooks/ajsc-aai-auth/README.md')
-rw-r--r--cookbooks/ajsc-aai-auth/README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/cookbooks/ajsc-aai-auth/README.md b/cookbooks/ajsc-aai-auth/README.md
new file mode 100644
index 0000000..da8fe00
--- /dev/null
+++ b/cookbooks/ajsc-aai-auth/README.md
@@ -0,0 +1,68 @@
+ajsc-aai-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
+-----
+#### ajsc-aai-auth::default
+TODO: Write usage instructions for each cookbook.
+
+e.g.
+Just include `ajsc-aai-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