readme info

Author: emtiazzahid

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present emtiazzahid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -1 +1,46 @@
-# GIT LOG LARAVEL
+Git Log Laravel
+==================
+
+[![Packagist](https://img.shields.io/packagist/v/emtiazzahid/git-log-laravel.svg)](https://packagist.org/packages/emtiazzahid/git-log-laravel)
+[![Packagist](https://img.shields.io/packagist/l/emtiazzahid/git-log-laravel.svg)](https://packagist.org/packages/emtiazzahid/git-log-laravel) 
+[![Packagist](https://img.shields.io/packagist/dm/emtiazzahid/git-log-laravel.svg)](https://packagist.org/packages/emtiazzahid/git-log-laravel) 
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7be7a05b07c94f319ec35f95a4d64074)](https://www.codacy.com/app/emtiazzahid/git-log-laravel.svg)
+[![Author](https://img.shields.io/badge/author-@emtiaz_zahid-blue.svg)](https://twitter.com/emtiaz_zahid)
+
+
+TL;DR
+-----
+Git Log Viewer for Laravel 5, 6. **Install with composer, create a route to `GitLogLaravelController`**. No public assets, no vendor routes, works with and/or without log rotate. Inspired by rap2hpoutre's [Laravel log viewer](https://github.com/rap2hpoutre/laravel-log-viewer) 
+
+Install (Laravel)
+-----------------
+Install via composer
+```
+composer require emtiazzahid/git-log-laravel
+```
+
+Add Service Provider to `config/app.php` in `providers` section
+```php
+Emtiazzahid\GitLogLaravel\GitLogServiceProvider::class,
+```
+
+Add a route in your web routes file:
+```php 
+Route::get('git_log', '\EmtiazZahid\GitLogLaravel\GitLogLaravelController@index');
+```
+
+Go to `http://myapp/git_log` or some other route
+
+**Optionally** publish `git.blade.php` into `/resources/views/vendor/git-log-laravel/` for view customization:
+
+```
+php artisan vendor:publish \
+ --provider="EmtiazZahid\GitLogLaravel\GitLogServiceProvider" \
+ --tag=views
+``` 
+
+Troubleshooting
+---------------
+
+If you got a `InvalidArgumentException in FileViewFinder.php` error, it may be a problem with config caching. Double check installation, then run `php artisan config:clear`.
+