changed readme

Author: edanisko

README.md

@@ -2,8 +2,11 @@
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/nrml-co/laravel-api-keys.svg?style=flat-square)](https://packagist.org/packages/nrml-co/laravel-api-keys)
 [![Build Status](https://img.shields.io/travis/nrml-co/laravel-api-keys/master.svg?style=flat-square)](https://travis-ci.org/nrml-co/laravel-api-keys)
-[![Quality Score](https://img.shields.io/scrutinizer/g/nrml-co/laravel-api-keys.svg?style=flat-square)](https://scrutinizer-ci.com/g/nrml-co/laravel-api-keys)
 [![Total Downloads](https://img.shields.io/packagist/dt/nrml-co/laravel-api-keys.svg?style=flat-square)](https://packagist.org/packages/nrml-co/laravel-api-keys)
+<!--
+[![Quality Score](https://img.shields.io/scrutinizer/g/nrml-co/laravel-api-keys.svg?style=flat-square)](https://scrutinizer-ci.com/g/nrml-co/laravel-api-keys)
+-->
+
 
 This package offers a different type on API key system for Laravel.  The other options are either too simple or too complex.
 
@@ -16,7 +19,6 @@ This package offers:
 - scopes
 
 Laravel/Passport is a the full on oauth implementation.  This is a little more simple.     
-  
 
 ## Installation
 
@@ -26,11 +28,80 @@ You can install the package via composer:
 composer require nrml-co/laravel-api-keys
 php artisan migrate
 ```
+Laravel 5.8 and above will register the service provider automatically.
+
+## Usage - Creating Keys
+First add the HasApiKeys trait to the User model that ships with Laravel.
+```php
+use NrmlCo\LaravelApiKeys\HasApiKeys;
+
+
+/**
+ * Class User
+ * @package App
+ */
+class User extends Authenticatable
+{
+    use Notifiable;
+    use HasApiKeys;
+
+```
+
+Next create a User.  
+``` php
+$user = User::create([
+        'name' => 'Ed Anisko',
+        'email' => 'ed@nrml.co',
+        'email_verified_at' => now(),
+        'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
+        'remember_token' => Str::random(10)
+        ]);
+```
+
+The user needs to be logged in.  Programmatically it looks like this.  
+``` php
+Auth::setUser($user);
+```
+
+And not the package will create ApiKeys for the Authorized user.   
+``` php
+LaravelApiKeys::create(LaravelApiKeyType::PRODUCTION); // default is SANDBOX
+```
 
-## Usage
-Laravel 5.8 and above will register the service provider automatically
+## Using the your API Keys
+Change config/auth.php
 ``` php
-// Usage description here
+    'guards' => [
+        'web' => [
+            'driver' => 'session',
+            'provider' => 'users',
+        ],
+
+        'api' => [
+            'driver' => 'lak',
+            'provider' => 'users',
+            'hash' => true,
+        ],
+
+    ]
+```
+
+
+User the 'auth:lak' middleware in your api.php routes.
+``` php
+Route::middleware('auth:lak')->get('/user', function (Request $request) {
+    return $request->user();
+});
+```
+
+Check your work from the command line.
+``` bash
+
+$ curl -X GET \
+  http://homestead.test/api/user \
+  -H 'Accept: application/json' \
+  -H 'x-api-key: al4PA8V5jSuq4oFJOxK6lS4CeZEkDFtayBObJTHJ'
+
 ```
 
 ### Testing