Merge pull request #18 from bjoernmeier/add-url-docu

Add README section for URL types

Author: marco-neumann-by

README.rst

@@ -63,6 +63,20 @@ There are two possibilities to use storefact.
     store.put(u'key', b'value')
     assert store.get(u'key') == b'value'
 
+URL and store types:
+
+* In memory: :code:`memory://` and :code:`hmemory://`.
+* Redis: :code:`redis://[[password@]host[:port]][/db]` and :code:`hredis://[[password@]host[:port]][/db]`
+* Filesystem: :code:`fs://` and :code:`hfs://`
+* Amazon S3: :code:`s3://access_key:secret_key@endpoint/bucket[?create_if_missing=true]` and :code:`hs3://access_key:secret_key@endpoint/bucket[?create_if_missing=true]`
+* Azure Blob Storage (:code:`azure://` and :code:`hazure://`):
+    * with storage account key: :code:`azure://account_name:account_key@container[?create_if_missing=true][?max_connections=2]`
+    * with SAS token: :code:`azure://account_name:shared_access_signature@container?use_sas&create_if_missing=false[?max_connections=2&socket_timeout=(20,100)]`
+    * with SAS and additional parameters: :code:`azure://account_name:shared_access_signature@container?use_sas&create_if_missing=false[?max_connections=2&socket_timeout=(20,100)][?max_block_size=4*1024*1024&max_single_put_size=64*1024*1024]`
+
+Storage URLs starting with a :code:`h` indicate extended allowed characters. This allows the usage of slashes and spaces in blob names.
+URL options with :code:`[]` are optional and the :code:`[]` need to be removed.
+
 Documentation
 =============