diff --git a/README.md b/README.md index 3cc2e84..8b6eea3 100644 --- a/README.md +++ b/README.md @@ -1,82 +1 @@ -Use this repo as a skeleton for your new channel, once you're done please submit a Pull Request on [this repo](https://github.com/laravel-notification-channels/new-channels) with all the files. - -Here's the latest documentation on Laravel 5.3 Notifications System: - -https://laravel.com/docs/master/notifications - -# A Boilerplate repo for contributions - -[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/:package_name.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/:package_name) -[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) -[![Build Status](https://img.shields.io/travis/laravel-notification-channels/:package_name/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/:package_name) -[![StyleCI](https://styleci.io/repos/:style_ci_id/shield)](https://styleci.io/repos/:style_ci_id) -[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/:sensio_labs_id.svg?style=flat-square)](https://insight.sensiolabs.com/projects/:sensio_labs_id) -[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/:package_name) -[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/:package_name/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/:package_name/?branch=master) -[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/:package_name.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/:package_name) - -This package makes it easy to send notifications using [:service_name](link to service) with Laravel 5.3. - -**Note:** Replace ```:channel_namespace``` ```:service_name``` ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` ```:style_ci_id``` ```:sensio_labs_id``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md), [composer.json](composer.json) and other files, then delete this line. -**Tip:** Use "Find in Path/Files" in your code editor to find these keywords within the package directory and replace all occurences with your specified term. - -This is where your description should go. Add a little code example so build can understand real quick how the package can be used. Try and limit it to a paragraph or two. - - - -## Contents - -- [Installation](#installation) - - [Setting up the :service_name service](#setting-up-the-:service_name-service) -- [Usage](#usage) - - [Available Message methods](#available-message-methods) -- [Changelog](#changelog) -- [Testing](#testing) -- [Security](#security) -- [Contributing](#contributing) -- [Credits](#credits) -- [License](#license) - - -## Installation - -Please also include the steps for any third-party service setup that's required for this package. - -### Setting up the :service_name service - -Optionally include a few steps how users can set up the service. - -## Usage - -Some code examples, make it clear how to use the package - -### Available Message methods - -A list of all available options - -## Changelog - -Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. - -## Testing - -``` bash -$ composer test -``` - -## Security - -If you discover any security related issues, please email :author_email instead of using the issue tracker. - -## Contributing - -Please see [CONTRIBUTING](CONTRIBUTING.md) for details. - -## Credits - -- [:author_name](https://github.com/:author_username) -- [All Contributors](../../contributors) - -## License - -The MIT License (MIT). Please see [License File](LICENSE.md) for more information. +# Service Bus Notifications Channel