Merge pull request #9 from eldarion/add-docs

Document storage backend settings

README.rst

@@ -13,3 +13,49 @@ Requirements
 --------------
 
 * Django 1.8+
+
+Settings
+--------
+Set the ``GCS_BUCKET`` environment variable to the GCS bucket to be used
+by the storage backend.
+
+Settings can be customized via the `GPAC_STORAGE` settings dict::
+
+    GPAC_STORAGE = {
+        "allow_overwrite": False,
+        "bucket": "my-bucket",
+        "cache_control": "public, max-age=3600",
+        "path_prefix": "",
+    }
+
+
+``GPAC_STORAGE["allow_overwrite"]``
+===================================
+
+Default: ``False``
+
+If ``True``, the storage backend will overwrite an existing object with
+the same name.
+
+``GPAC_STORAGE["bucket"]``
+==========================
+
+Default: ``os.environ["GCS_BUCKET"]``
+
+``GPAC_STORAGE["cache_control"]``
+=================================
+
+Default: ``public, max-age=3600``
+
+By default, public-readable objects on GCS have a cache duration of 60
+minutes.  Set ``cache_control`` to ``private, max-age=0`` to disable
+public caching of objects saved by the storage backend.
+
+``GPAC_STORAGE["path_prefix"]``
+===============================
+
+Default: ``""``
+
+A prefix appended to the path of objects saved by the storage backend.
+For example, configuring path_prefix to ``media`` would save
+objects to ``my-bucket/media``.