Working on more documentation.

Author: stevebauman

docs/auth/installation.md

@@ -1,12 +1,11 @@
 # Auth Driver
 
-The Adldap Laravel auth driver allows you to seamlessly authenticate AD users,
+The Adldap2 Laravel auth driver allows you to seamlessly authenticate LDAP users,
 as well as have a local database record of the user.
 
 This allows you to easily attach information to the users account
 as you would a regular laravel application.
 
-> **Note**: The Adldap auth driver actually extends from and utilizes Laravel's eloquent auth driver.
 
 ## Installation
 
@@ -65,10 +64,9 @@ Change the `driver` value inside the `users` authentication provider to `adldap`
 Inside your `config/adldap_auth.php` file there is a configuration option named `usernames`.
 
 This array contains the `ldap` attribute you use for authenticating users, as well
-as the `eloquent` attribute for locating the LDAP users model.
+as the `eloquent` attribute for locating the LDAP users local model.
 
 ```php
-
 'usernames' => [
 
     'ldap' => 'userprincipalname',
@@ -86,7 +84,6 @@ If you're using a `username` field instead of `email` in your application, you w
 For example, if you'd like to login users by their `samaccountname`:
 
 ```php
-
 'usernames' => [
 
     'ldap' => 'samaccountname',
@@ -101,7 +98,7 @@ Be sure to update the `sync_attributes` option to synchronize the users `usernam
 ```php
 'sync_attributes' => [
 
-    'username' => 'samaccountname', // Changed from 'email' => 'userprincipalname'
+    'username' => 'samaccountname',
     'name' => 'cn',
 
 ],
@@ -129,4 +126,4 @@ public function login(Request $request)
     return redirect()->to('login')
         ->withMessage('Hmm... Your username or password is incorrect');
 }
-```
+```

docs/auth/upgrading.md

@@ -0,0 +1,96 @@
+# Upgrading From 2.* to 3.*
+  
+## Upgrade 
+
+**Estimated Upgrade Time: 1 hour**
+  
+There are significant changes to the code base from `v2` to `v3`.
+
+### Configuration
+
+1. Delete your `config/adldap_auth.php`
+2. Run `php artisan vendor:publish --tag="adldap"`
+3. Reconfigure auth driver in `config/adldap_auth.php`
+
+#### Username Attribute
+
+The username attribute has been renamed to the `usernames` array.
+
+You must specify your LDAP login attribute as well as your `eloquent` attribute.
+
+```php
+// v2.0
+
+'username_attribute' => ['email' => 'mail'],
+
+// v3.0
+
+'usernames' => [
+    'ldap' => 'mail',
+    
+    'eloquent' => 'email',
+],
+```
+
+#### Login Attribute
+
+The configuration option `login_attribute` has been removed in favor
+of the `ldap` option inside the `usernames` array.
+
+#### Binding Users to Model
+
+If you were using the `bind_user_to_model` option, you previously inserted
+the following trait onto your `User` model:
+ 
+```php
+Adldap\Laravel\Traits\AdldapUserModelTrait
+```
+
+You must replace this with:
+
+```php
+Adldap\Laravel\Traits\HasLdapUser
+```
+
+For example:
+
+```php
+use Adldap\Laravel\Traits\HasLdapUser;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class User extends Authenticatable
+{
+    use HasLdapUser;
+```
+
+The configuration option itself (inside `config/adldap_auth.php`) has
+been removed in favor of utilizing the trait itself instead.
+
+#### Limitation Filter
+
+If you were using the `limitation_filter` option, this has been replaced with the `scopes` option.
+
+> **Note**: For more about this option, please read the [documentation](scopes.md).
+
+You must create and define a query scope that includes your filter. For example:
+
+```php
+namespace App\Ldap\Scopes;
+
+use Adldap\Laravel\Scopes\ScopeInterface;
+
+class LimitationScope implements ScopeInterface
+{
+    public function apply($query)
+    {
+        $query->rawFilter('(cn=John Doe)');
+    }
+}
+```
+
+#### Select Attributes
+
+The configuration option `select_attributes` has been removed.
+
+If you would like to limit the attributes for the query on your LDAP
+server when locating users, please use a [Scope](scopes.md).

readme.md

@@ -17,6 +17,7 @@ Adldap2 - Laravel allows easy configuration, access, management and authenticati
 * [Installation](#installation)
 * [Usage](#usage)
 * [Auth Driver](#auth-driver)
+  * [Upgrading](docs/auth/upgrading.md)
   * [Quick Start - From Scratch](docs/quick-start.md)
   * [Installation & Basic Setup](docs/auth/installation.md)
   * Features
@@ -125,11 +126,3 @@ class UserController extends Controller
 ```
 
 To see more usage in detail, please visit the [Adldap2 Repository](http://github.com/Adldap2/Adldap2).
-
-## Upgrading From 2.* to 3.*
-
-If using the Adldap2 auth driver, please follow these steps:
-
-1. Delete your `config/adldap_auth.php`
-2. Run `php artisan vendor:publish --tag="adldap"`
-3. Reconfigure auth driver in `config/adldap_auth.php`