list attributes and recipes in readme

README.md

@@ -21,15 +21,45 @@ Consult the Graphite documentation for more information:
 * RHEL and derivatives (Centos, Amazon Linux, Oracle Linux, Scientific Linux)
 * Fedora
 
-## Usage
-
-It's a library cookbook, intended to be used in your custom wrapper
-cookbook to behave as needed. It's the building materials, not the
-house.
-
-For example usage consult the reference cookbook [example](https://github.com/hw-cookbooks/graphite/tree/master/example/graphite_example/recipes)
-
-Feel free to ask us questions anytime on irc: #heavywater on freenode
+## Attributes
+See
+[default attributes](https://github.com/hw-cookbooks/graphite/blob/master/attributes/default.rb#L48)
+for platform specific packages installed.
+
+- `node['graphite']['version']` - package version to install, defaults to '0.9.12'
+- `node['graphite']['twisted_version']` - twisted version to pin to,
+  defaults to '13.1'
+- `node['graphite']['django_version']` - django version to use,
+  defaults to '1.5.5'
+- `node['graphite']['user']` - graphite user, 'graphite'
+- `node['graphite']['group']` - graphite group, 'graphite'
+- `node['graphite']['base_dir']` - default base dir, '/opt/graphite'
+- `node['graphite']['doc_root']` - doc root for graphite-web, '/opt/graphite/webapp'
+- `node['graphite']['storage_dir'] ` - storage dir, '/opt/graphite/storage'
+- `node['graphite']['install_type']` - 'package' or 'source'. Setting
+  this to source will use latest github master branch
+- `default['graphite']['package_names']` - package name hash, indexed
+  by 'install_type' attribute.
+- `default['graphite']['graph_templates']` - graphite template config hash
+
+### Adjusting package source location
+
+You can override the
+`node['graphite']['package_names'][#{name}]['source']` attribute,
+where `#{name}` is one of `whisper`, `carbon` or `graphite_web`, to
+set a custom install path. By default a source install will use the
+github master branch.
+
+## Recipes
+### default
+No-op, assuming cookbook inclusion in a custom wrapper.
+
+### packages
+Just install all packages, carbon and web
+
+### carbon
+Install all carbon packages, setup the graphite user, storage paths
+and write the carbon configuration. Does not start any services.
 
 ## Custom Resources