diff --git a/README.md b/README.md index f48c75d..04dbbd3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -Notification for Laravel 4 +Messages Component for Laravel 4 and Orchestra Platform 2 ============== -Messages Component bring a unified notification support for Laravel 4. +Messages Component bring a unified notification support for Laravel 4 and Orchestra Platform 2. [![Latest Stable Version](https://poser.pugx.org/orchestra/messages/v/stable.png)](https://packagist.org/packages/orchestra/messages) [![Total Downloads](https://poser.pugx.org/orchestra/messages/downloads.png)](https://packagist.org/packages/orchestra/messages) @@ -9,7 +9,19 @@ Messages Component bring a unified notification support for Laravel 4. [![Coverage Status](https://coveralls.io/repos/orchestral/messages/badge.png?branch=master)](https://coveralls.io/r/orchestral/messages?branch=master) [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/orchestral/messages/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/orchestral/messages/) -## Quick Installation +## Table of Content + +* [Version Compatibility](#version-compatibility) +* [Installation](#installation) +* [Configuration](#configuration) +* [Usage](#usage) +* [Change Log](http://orchestraplatform.com/docs/latest/components/messages/changes#v2-2) + +Laravel | Messages +:----------|:---------- + 4.2.x | 2.2.x@dev + +## Installation To install through composer, simply put the following in your `composer.json` file: @@ -21,8 +33,20 @@ To install through composer, simply put the following in your `composer.json` fi } ``` +And then run `composer install` from the terminal. + +### Quick Installation + +Above installation can also be simplify by using the following command: + + composer require "orchestra/messages=2.2.*" + Next add the service provider in `app/config/app.php`. +## Configuration + +Add `Orchestra\Messages\MessagesServiceProvider` service provider in `app/config/app.php`. + ```php 'providers' => array( @@ -32,7 +56,19 @@ Next add the service provider in `app/config/app.php`. ), ``` +### Aliases + +You might want to add `Orchestra\Messages\Facade` to class aliases in `app/config/app.php`: + +```php +'aliases' => array( + + // ... + + 'Orchestra\Messages' => 'Orchestra\Messages\Facade', +), +``` + ## Resources -* [Documentation](http://orchestraplatform.com/docs/latest/components/support) -* [Change Log](http://orchestraplatform.com/docs/latest/components/messages/changes#v2-2) +* [Documentation](http://orchestraplatform.com/docs/latest/components/messages) diff --git a/composer.json b/composer.json index e6f1eff..371ca95 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "orchestra/messages", - "description": "Messages Component for Orchestra Platform 2", + "description": "Messages Component for Laravel 4 and Orchestra Platform 2", "homepage": "http://orchestraplatform.com/docs/latest/components/messages/", "keywords": ["orchestra-platform", "orchestral", "laravel", "messages", "notification"], "license": "MIT", diff --git a/src/Messages/Facade.php b/src/Messages/Facade.php new file mode 100644 index 0000000..0dee02b --- /dev/null +++ b/src/Messages/Facade.php @@ -0,0 +1,14 @@ +