Permalink
Browse files

Revision

- Add missing sections in README.
- Add tip in README.
- Add :service_name in README and related files.
- Update related files to reflect these changes and missing keywords.
- Fix typo.
  • Loading branch information...
1 parent d9d64fd commit 5a65a92231eb0f66e268e63d73046ddec7787550 @irazasyed irazasyed committed Aug 13, 2016
Showing with 28 additions and 12 deletions.
  1. +20 −4 README.md
  2. +4 −4 composer.json
  3. +1 −1 phpunit.xml.dist
  4. +1 −1 src/ServiceNameChannel.php
  5. +1 −1 src/ServiceNameMessage.php
  6. +1 −1 src/ServiceNameServiceProvider.php
View
@@ -6,17 +6,19 @@ https://laravel.com/docs/master/notifications
# A Boilerplate repo for contributions
-This package makes it easy to send notifications using [xxxxx](link to service) with Laravel 5.3.
+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``` 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 occurence with your specified term.
-**Note:** Replace ```:channel_namespace``` ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line.
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 xxxx service](#setting-up-the-xxxx-service)
+ - [Setting up the :service_name service](#setting-up-the-:service_name-service)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
@@ -31,7 +33,7 @@ This is where your description should go. Add a little code example so build can
Please also include the steps for any third-party service setup that's required for this package.
-### Setting up the xxxx service
+### Setting up the :service_name service
Optionally include a few steps how users can set up the service.
@@ -43,6 +45,20 @@ Some code examples, make it clear how to use the package
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.
View
@@ -1,13 +1,13 @@
{
- "name": "laravel-notification-channels/skeleton",
- "description": "A boilerplate for contributions.",
- "homepage": "https://github.com/laravel-notification-channels/skeleton",
+ "name": "laravel-notification-channels/:package_name",
+ "description": ":package_description",
+ "homepage": "https://github.com/laravel-notification-channels/:package_name",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": ":author_email",
- "homepage": ":author_url",
+ "homepage": ":author_website",
"role": "Developer"
}
],
View
@@ -10,7 +10,7 @@
processIsolation="false"
stopOnFailure="false">
<testsuites>
- <testsuite name="Spatie Test Suite">
+ <testsuite name=":service_name Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
@@ -7,7 +7,7 @@
use NotificationChannels\:channel_namespace\Events\SendingMessage;
use Illuminate\Notifications\Notification;
-class Channel
+class :service_nameChannel
{
public function __construct()
{
@@ -4,7 +4,7 @@
use Illuminate\Support\Arr;
-class Message
+class :service_nameMessage
{
// Message structure here
}
@@ -4,7 +4,7 @@
use Illuminate\Support\ServiceProvider;
-class Provider extends ServiceProvider
+class :service_nameProvider extends ServiceProvider
{
/**
* Bootstrap the application services.

0 comments on commit 5a65a92

Please sign in to comment.