Merge master

ZF-Commons · Jul 21, 2015 · 527dfbf · 527dfbf
2 parents 5d8c11c + b7baa08
commit 527dfbf
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,31 @@
 ZfcUserDoctrineMongoODM
 =======================
-Version 0.0.1 Created by Evan Coury and the ZF-Commons team
 
 Introduction
 ------------
 ZfcUserDoctrineMongoODM is a MongoDb storage adapter for [ZfcUser](https://github.com/ZF-Commons/ZfcUser). This module makes use of the Doctrine2 MongoDB ODM.
 
+Installation
+------------
+
+### Composer
+
+1. Install module   
+Go to the [release tab](https://github.com/ZF-Commons/ZfcUserDoctrineMongoODM/releases) and make a note of the most recent version.
+Run the following command from your application directory:
+```php composer.phar require zf-commons/zfc-user-doctrine-mongo-odm```
+When asked for er version constraint, put in the version noted from the release tab.
+
+2. Add ```DoctrineModule```, ```DoctrineMongoODMModule``` and ```ZfcUserDoctrineMongoODM``` to ```config/application.config.php```
+
+Options
+------------
+
+The following options are available:
+
+- **enable_default_entities** - Boolean value, determines if the default User entity should be enabled. Set it to false in order to extend ZfcUser\Entity\User with your own entity. Default is true.
+
+
 Dependencies
 ------------
 

diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
     "minimum-stability": "dev",
     "extra": {
         "branch-alias": {
-            "dev-master": "0.2.x-dev"
+            "dev-master": "0.1.x-dev"
         }
     },
     "autoload": {