<commit_before>EdpUser
=======
Version 0.0.1 Created by <NAME>

Introduction
------------

**NOTE:** This is a work-in-progress. The features listed may be incomplete or
entirely missing.

EdpUser is a ZF2 module which utilizes Doctrine2. It provides the foundations
for adding user authentication and registration to your ZF2 site. It is built to
be very simple and easily to extend.

Features
--------

* Authenticate via username, email, or both (can opt out of the concept of
  username and use strictly email)
* E-mail address verification (optional)
* Forgot Password
* User Registration
* Robust event system to allow for extending<commit_msg>Update readme with basic install instructions<commit_after>EdpUser
=======
Version 0.0.1 Created by <NAME>

Introduction
------------

**NOTE:** This is a work-in-progress. The features listed may be incomplete or
entirely missing.

EdpUser is a ZF2 module which utilizes Doctrine2. It provides the foundations
for adding user authentication and registration to your ZF2 site. It is built to
be very simple and easily to extend.

Requirements
------------
* Zend Framework 2 (currently depends on commit [a8de089](https://github.com/ralphschindler/zf2/commit/a8de0890e216e9826be3414a818c333e2f307028) from <NAME>ler's [hotfix/di](https://github.com/ralphschindler/zf2/tree/hotfix/di) branch.
* [SpiffyDoctrine](https://github.com/SpiffyJr/SpiffyDoctrine)

Installation
------------
1. Install [SpiffyDoctrine](https://github.com/SpiffyJr/SpiffyDoctrine) per the [README](https://github.com/SpiffyJr/SpiffyDoctrine/blob/master/README.md)
2. Clone EdpUser into your modules directory:
    1. `cd path/to/project/modules`
    2. `git clone git://github.com/EvanDotPro/EdpUser.git`
3. Enable EdpUser in your `application.config.php` modules array.
4. Create the `user` table in your database via the Doctrine CLI:
    1. `cd path/to/SpiffyDoctrine/bin`
    2. `./doctrine orm:schema:create`
5. Navigate to http://yourproject/user and you should land on a login page.


Features
--------
(Most of these are not complete yet)

* Authenticate via username, email, or both (can opt out of the concept of
  username and use strictly email)
* E-mail address verification (optional)
* Forgot Password
* User Registration
* Robust event system to allow for extending
{'fraction_non_alphanumeric': 0.1115451388888889, 'fraction_numerical': 0.024739583333333332, 'mean_word_length': 3.978401727861771, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4761010', 'n_tokens_mistral': 731, 'n_tokens_neox': 690, 'n_words': 260}