Skip to content

Commit

Permalink
Merge pull request #15 from Danielss89/docs-installation
Browse files Browse the repository at this point in the history
Installation instructions + options information
  • Loading branch information
Danielss89 committed Apr 6, 2014
2 parents 32a33ec + 7088399 commit 8e4aea2
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
------------

Expand Down

0 comments on commit 8e4aea2

Please sign in to comment.