Merge remote-tracking branch 'github/pull/74'

[chef.git] / cookbooks / db / README.md

diff --git a/cookbooks/db/README.md b/cookbooks/db/README.md
index 205739199955017d846700bb599100dae9f89479..30fd81fd184fefd7da17d33e3972f930282307d7 100644 (file)
--- a/cookbooks/db/README.md
+++ b/cookbooks/db/README.md
@@ -1,34 +1,11 @@
-Cookbook
-========
-TODO: Enter the cookbook description here.
+# db Cookbook

 
 

-e.g.
-This cookbook makes your favorite breakfast sandwich.
+This cookbook installs and configures the PostgreSQL database required by the
+openstreetmap-website (aka Rails Port) codebase.

 
 

-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
+There are four recipes available:

 
 

-Attributes
-----------
-TODO: List you cookbook attributes here.
-
-Usage
------
-TODO: Write usage instructions for each cookbook.
-
-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
+* backup: configures the pg_dump-based backups and rsyncing to the backup server.
+* base: installs the database and rails port codebase.
+* master: configuration of user accounts etc that happen on the master server.
+* slave: placeholder for slave database configuration.