diff --git a/README.md b/README.md index dbfeadc..0b9c3b7 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,17 @@ Laravel log viewer [![Author](https://img.shields.io/badge/author-@rap2h-blue.svg)](https://twitter.com/rap2h) -TL;DR ------ +## TL;DR Log Viewer for Laravel 5, 6 (compatible with 4.2 too) and Lumen. **Install with composer, create a route to `LogViewerController`**. No public assets, no vendor routes, works with and/or without log rotate. Inspired by Micheal Mand's [Laravel 4 log viewer](https://github.com/mikemand/logviewer) (works only with laravel 4.1) -What ? ------- +## What ? Small log viewer for laravel. Looks like this: ![capture d ecran 2014-12-01 a 10 37 18](https://cloud.githubusercontent.com/assets/1575946/5243642/8a00b83a-7946-11e4-8bad-5c705f328bcc.png) -Install (Laravel) ------------------ +## Install (Laravel) Install via composer -``` +```bash composer require rap2hpoutre/laravel-log-viewer ``` @@ -39,26 +36,9 @@ Route::get('logs', '\Rap2hpoutre\LaravelLogViewer\LogViewerController@index'); Go to `http://myapp/logs` or some other route -**Optionally** publish `log.blade.php` into `/resources/views/vendor/laravel-log-viewer/` for view customization: - -``` -php artisan vendor:publish \ - --provider="Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider" \ - --tag=views -``` - -**Optionally** publish `logviewer.php` configuration file into `/config/` directory of your app for configuration customization: - -``` -php artisan vendor:publish \ - --provider="Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider" -``` - -Install (Lumen) ---------------- - +### Install (Lumen) Install via composer -``` +```bash composer require rap2hpoutre/laravel-log-viewer ``` @@ -74,8 +54,24 @@ $router->group(['namespace' => '\Rap2hpoutre\LaravelLogViewer'], function() use }); ``` -Troubleshooting ---------------- +## Advanced usage +### Customize view +Publish `log.blade.php` into `/resources/views/vendor/laravel-log-viewer/` for view customization: + +```bash +php artisan vendor:publish \ + --provider="Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider" \ + --tag=views +``` + +### Edit configuration +Publish `logviewer.php` configuration file into `/config/` for configuration customization: + +```bash +php artisan vendor:publish \ + --provider="Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider" +``` +### 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`.