Updated README

Author: neelkanthk

README.md

@@ -1,6 +1,19 @@
-# Laravel Surveillance UI
+![Laravel Surveillance UI Logo](https://github.com/neelkanthk/repo_logos/blob/master/LaravelSurveillanceUI_small.png?raw=true)
 
-Provides UI interface for Laravel Surveillance Package
+![](https://img.shields.io/github/v/release/neelkanthk/laravel-surveillance-ui?style=for-the-badge)
+![](https://img.shields.io/packagist/php-v/neelkanthk/laravel-surveillance-ui.svg?style=for-the-badge)
+![](https://img.shields.io/badge/Laravel-%3E%3D6.0-red?style=for-the-badge)
+![](https://img.shields.io/github/stars/neelkanthk/laravel-surveillance-ui?style=for-the-badge)
+![](https://img.shields.io/github/issues/neelkanthk/laravel-surveillance-ui?style=for-the-badge)
+![](https://img.shields.io/github/license/neelkanthk/laravel-surveillance-ui?style=for-the-badge)
+
+## What is Laravel Surveillance UI?
+
+Provides a Graphical UI for [Laravel Surveillance](https://github.com/neelkanthk/laravel-surveillance) and integrates within your existing application.
+
+## What is Laravel Surveillance?
+
+Laravel Surveillance is a package to put malicious users, IP addresses and anonymous browser fingerprints under surveillance, write surveillance logs and block malicious ones from accessing the app. [Read more](https://github.com/neelkanthk/laravel-surveillance#laravel-surveillance-)
 
 ## Minimum Requirements
 
@@ -10,11 +23,98 @@ Provides UI interface for Laravel Surveillance Package
 ## Installation  
 
 ```bash
-composer require neelkanthk/laravel-schedulable-ui
+composer require neelkanthk/laravel-surveillance-ui
 ```
 
 ## Usage
 
+## Step 1: [Configure Laravel Surveillance](#step-1)
+
+_NOTE:- If you have already installed ```neelkanthk/laravel-surveillance``` in your application then please go directly to Step 2_.
+
+
+#### 1.1. Publish the migration files:
+```bash
+php artisan vendor:publish --provider="Neelkanth\Laravel\Surveillance\Providers\SurveillanceServiceProvider" --tag="migrations"
+```
+
+#### 1.2. Publish language files:
+```bash
+php artisan vendor:publish --provider="Neelkanth\Laravel\Surveillance\Providers\SurveillanceServiceProvider" --tag="lang"
+```
+
+#### 1.3. Run the migrations
+```bash
+php artisan migrate
+```
+
+#### 1.4. Publish the config file (Optional):
+```bash
+php artisan vendor:publish --provider="Neelkanth\Laravel\Surveillance\Providers\SurveillanceServiceProvider" --tag="config"
+```
+
+[Read more about Laravel Surveillance installation](https://github.com/neelkanthk/laravel-surveillance#installation)
+
+## Step 2: [Configure Laravel Surveillance UI](#step-2)
+
+_The following steps will install Laravel Surveillance UI in your application_.
+
+#### 2.1. Publish views:
+```bash
+php artisan vendor:publish --provider="Neelkanth\Laravel\SurveillanceUi\Providers\SurveillanceUiServiceProvider" --tag="views"
+```
+
+#### 2.2. Publish config:
+```bash
+php artisan vendor:publish --provider="Neelkanth\Laravel\SurveillanceUi\Providers\SurveillanceUiServiceProvider" --tag="config"
+```
+
+#### 2.3. Publish assets:
+```bash
+php artisan vendor:publish --provider="Neelkanth\Laravel\SurveillanceUi\Providers\SurveillanceUiServiceProvider" --tag="assets"
+```
+
+## Add Middleware
+
+Laravel Surveillance provides a ```surveillance``` middleware that can be used on any route or route group to make it eligible for surveillance.
+
+```php
+Route::middleware(["surveillance"])->get('/path', function () {});
+```
+
+[Read more about middleware usage](https://github.com/neelkanthk/laravel-surveillance#middleware-usage)
+
+## Accessing the Dashboard
+
+The **Laravel Surveillance UI manager dashboard** can be accessed at: http://your.domain/surveillance/ui/manager
+
+The **Laravel Surveillance UI logs dashboard** can be accessed at: http://your.domain/surveillance/ui/logs
+
+## Customizing the package routes
+
+### Customizing the route prefix
+
+By default ```surveillance/ui``` route prefix is appended to the package's routes.
+If you want to customize it then you can do so easily in the ```config/surveillance-ui.php``` file's file's _**prefix**_ key as shown below.
+
+```php
+/**
+ * The prefix to be used in the surveillance ui routes
+ */
+"prefix" => "surveillance/ui",
+```
+
+### Customizing the route middleware
+
+By default ```web``` middleware is added to the package's routes. If you want to add more middlewares like ```auth``` or something else, then you can add them easily in the ```config/surveillance-ui.php``` file's _**middleware**_ key as shown below.
+
+```php
+/**
+ * The middleware(s) to be used in the surveillance ui routes
+ */
+"middleware" => ["web", "auth"], //auth middleware added
+```
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
@@ -23,7 +123,7 @@ If you discover any security-related issues, please email me.neelkanth@gmail.com
 
 ## Credits
 
-- [Neelkanth Kaushik](https://github.com/username)
+- [Neelkanth Kaushik](https://github.com/neelkanthk)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -13,7 +13,7 @@
     "require": {
         "php": ">=7.2",
         "laravel/framework": ">=6.0",
-        "neelkanthk/laravel-surveillance": "^1.2"
+        "neelkanthk/laravel-surveillance": "^1.3"
     },
     "autoload": {
         "psr-4": {