From 76c64d115e52bd7f06ee4fd181bb39e700dd31b4 Mon Sep 17 00:00:00 2001 From: Fabio Rocha Date: Fri, 30 Apr 2021 10:25:23 -0300 Subject: [PATCH] Readme install --- README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..11c34df --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +# Laravel Discord Message +## _Send messsage to discord hook_ + +[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid) + +[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger) + +Project created to decouple the sending of messages to disagree, and in this way keep the project without fixed dependency. +Sending messages through the discord hook can facilitate the communication of errors, warn when a tariff ends, among many benefits. + + +## Features + +- Send message to channel discord with hook + +## Future Features + +- Send message to multiple channel discord with hook +- Integration Notification Laravel + +## Installation + +Laravel Discord Message requires [PHP Laravel](https://laravel.com) v8+ to run. + +Install the package + +```sh +composer require frf/discord-notification +``` + +After install - Create Discord Hook +## Open your channel config and create integration +![App Screenshot](https://github.com/frf/images-apps/blob/main/discord-message/integration.png?raw=true) +## Add name your hook and choose your channel +![App Screenshot](https://github.com/frf/images-apps/blob/main/discord-message/generate.png?raw=true) +## Put end of file ```.env``` configuration link hook in your ```.env``` +```enverioment +DISCORD_HOOK=https://discord.com/api/webhooks/4334343/XaFx43434343lGHYvQHoQO0ykhGRibx3w +``` + +### Exemple to use command line +```sh +php artisan discord:send_message Teste +``` +### Exemple to use injection service, +``Remembering that there is no better place on the controller 😅, I put it just as a practical example`` + +```php +sendMessage('Hello People!'); + + return view('welcome'); +}); +``` + +## License + +MIT + +**Free Software, Hell Yeah!** + +[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax) + +[laravel]: +[laravel]: +[dill]: +[git-repo-url]: +[john gruber]: +[df1]: +[markdown-it]: +[Ace Editor]: +[node.js]: +[Twitter Bootstrap]: +[jQuery]: +[@tjholowaychuk]: +[express]: +[AngularJS]: +[Gulp]: + +[PlDb]: +[PlGh]: +[PlGd]: +[PlOd]: +[PlMe]: +[PlGa]: