Skip to content

Commit fb8aa81

Browse files
committed
Installation instructions
1 parent bf6a755 commit fb8aa81

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,44 @@
1-
slack
2-
=====
1+
# Slack
2+
3+
A simple Laravel 4 package for sending messages to [Slack](https://slack.com) with [incoming webhooks](https://my.slack.com/services/new/incoming-webhook).
4+
5+
## Installation
6+
7+
You can install the package using the [Composer](https://getcomposer.org/) package manager. Assuming you have Composer installed globally:
8+
9+
```sh
10+
composer require maknz/slack:0.1.*
11+
```
12+
13+
### Service provider and alias
14+
15+
Next, add the `Maknz\Slack\SlackServiceProvider` service provider to the `providers` array in your `app/config.php` file.
16+
17+
```php
18+
'providers' => array(
19+
...
20+
'Maknz\Slack\SlackServiceProvider',
21+
),
22+
```
23+
24+
and then add the facade to your `aliases` array in your `app/config.php` file.
25+
26+
```php
27+
'aliases' => array(
28+
...
29+
'Slack' => 'Maknz\Slack\Facades\Slack',
30+
),
31+
```
32+
33+
### Configuration
34+
35+
Publish the configuration with
36+
37+
```php
38+
php artisan config:publish maknz/slack
39+
```
40+
41+
and add the URL to the webhook. If you haven't already created an incoming webhook for the package to use, [create one in your Slack backend](https://my.slack.com/services/new/incoming-webhook). The URL will be available under the "Instructions for creating Incoming WebHooks" panel.
42+
43+
## Usage
344

4-
A simple Laravel 4 package for sending messages to Slack

0 commit comments

Comments
 (0)