readme.md

Author: WebXScripts

CHANGELOG.md

@@ -2,6 +2,6 @@
 
 All notable changes to `lyra` will be documented in this file
 
-## 1.0.0 - 201X-XX-XX
+## 1.0.8 - 2023-01-01
 
 - initial release

README.md

@@ -1,30 +1,40 @@
-# Very short description of the package
+# Lyra
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/webxscripts/lyra.svg?style=flat-square)](https://packagist.org/packages/webxscripts/lyra)
 [![Total Downloads](https://img.shields.io/packagist/dt/webxscripts/lyra.svg?style=flat-square)](https://packagist.org/packages/webxscripts/lyra)
-![GitHub Actions](https://github.com/webxscripts/lyra/actions/workflows/main.yml/badge.svg)
 
-This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
+Send notifications about Laravel exceptions to Slack.
+
+This is my first package, so please let me know if you have any suggestions or feedback, I will be happy to hear them.
+
+Also, I want to add more features to this package (like Discord support), so if you have any ideas, please let me know.
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
 composer require webxscripts/lyra
+php artisan vendor:publish --provider="Webxscripts\Lyra\LyraServiceProvider" --tag="config"
+php artisan vendor:publish --provider="Webxscripts\Lyra\LyraServiceProvider" --tag="lang"
 ```
 
-## Usage
+*Remember to set your Slack webhook URL in the config file!*
+
+*Add following line in ```app/Exceptions/Handler.php``` file:*
 
 ```php
-// Usage description here
+public function report(Throwable $e): void
+{
+    $this->lyra->handle($e, Request::capture());
+}
 ```
 
-### Testing
+Now on error, you will get notification on your Slack channel:
 
-```bash
-composer test
-```
+![Slack Notification](https://i.imgur.com/aboaoq1.png)
+
+You can modify the notification message as per your need.
 
 ### Changelog
 
@@ -47,6 +57,8 @@ If you discover any security related issues, please email [email protected]
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
-## Laravel Package Boilerplate
+## Thanks to
+
+-   [Laravel Package Boilerplate](https://laravelpackageboilerplate.com) for the great package boilerplate.
+-   [Spatie](https://spatie.be/) for some code used in this package.
 
-This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).