update to version 5.0.0

amnah · Jan 31, 2016 · f921d61 · f921d61
1 parent ded8b30
commit f921d61
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 14 deletions.
diff --git a/Module.php b/Module.php
@@ -16,7 +16,7 @@ class Module extends \yii\base\Module
     /**
      * @var string Module version
      */
-    protected $version = "4.0.0";
+    protected $version = "5.0.0";
 
     /**
      * @var string Alias for module

diff --git a/README.md b/README.md
@@ -3,19 +3,11 @@ Yii 2 User
 
 Yii 2 User - User authentication module
 
-## New version released 11/09/2015
+## New version released 01/31/2016
 
-This release is a major code overhaul. Lots of refactoring, cleaning up, updating comments,
-etc. If you're upgrading from an earlier version, check out the [upgrade guide](UPGRADE.md).
-(Depending on how far you are into your project, it might be easier to stick with 
-```"amnah/yii2-user": "^3.0"```)
-
-Notably, there is one new feature: users can login/register via email. That is, the user enters
-his email address, gets a link in his inbox, and clicks that link to login/register. *No password
-needed.*
-
-Shamelessly stolen from [Medium](https://medium.com/m/signin). Demo of it
-[here](http://yii2.amnahdev.com/user/login-email)
+This release contains a few small updates and bug fixes. Most notably, I've changed
+`LoginForm.username` to `LoginForm.email` and added a timezone field to `app\models\Profile`
+(thanks [mnglkhn](https://github.com/amnah/yii2-user/pull/127))
 
 If there are any issues, [let me know](https://github.com/amnah/yii2-user/issues) and I'll get
 to it asap.
@@ -44,7 +36,7 @@ to it asap.
 ## Installation
 
 * Install [Yii 2](http://www.yiiframework.com/download) using your preferred method
-* Install package via [composer](http://getcomposer.org/download/) ```"amnah/yii2-user": "^4.0"```
+* Install package via [composer](http://getcomposer.org/download/) ```"amnah/yii2-user": "^5.0"```
 * Update config file *config/web.php* and *config/db.php*
 
 ```php

diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,6 +1,23 @@
 Yii 2 User - Upgrade notes
 =========
 
+## Upgrading from 4.0.0 to 5.0.0
+
+This release contains a few small updates and bug fixes. Most notably, I've changed
+`LoginForm.username` to `LoginForm.email` and added a timezone field to `app\models\Profile`
+(thanks [mnglkhn](https://github.com/amnah/yii2-user/pull/127))
+
+To upgrade to this version:
+
+* Change all references of `LoginForm.username` to `LoginForm.email`. This would be in 
+the [model](models/forms/LoginForm.php) and [view](views/default/login.php) files that 
+you extended
+
+* *Optional* - Add a `timezone` column to profile table in the database
+
+* *Optional* - Add [validation rules / attribute label](models/Profile.php#L29-L59) 
+(lines 29 and 59) for `timezone` field in Profile model 
+
 ## Upgrading from 3.0.0 to 4.0.0
 
 This release is a major code overhaul. Lots of refactoring, cleaning up, updating comments,