add README and LICENSE

Author: Hussam3bd

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) Liliom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,101 @@
+# laravel-firebase
+This package makes it easy to send notifications using Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) (FCM) with Laravel Notification Channel.
+
+## Installation
+
+This package can be installed through Composer.
+
+``` bash
+composer require liliom/laravel-firebase
+```
+
+If you don't use Laravel 5.5+ you have to add the service provider manually
+
+```php
+// config/app.php
+'providers' => [
+    ...
+    Liliom\Firebase\FirebaseServiceProvider::class,
+    ...
+];
+```
+
+Now add you Firebase API Key in `config/services.php`.
+
+```php
+return [
+	....
+    'firebase' => [
+        'key' => ''
+    ],
+    ....
+];
+```
+
+## Usage
+
+Les's create a notification using artisan commend:
+
+```bash
+php artisan make:notification FirebaseNotification
+```
+
+Now you can use `firebase` channel in your `vie()` mothod.
+
+```php
+public function via($notifiable)
+{
+    return ['firebase'];
+}
+```
+
+Add a pubilc method `toFirebase($notifiable)` to your notification class, and return an instance of `FirebaseMessage`:
+
+```php
+public function toFirebase($notifiable)
+{
+    return (new \Liliom\Firebase\FirebaseMessage)
+        ->notification([
+            'title' => 'Notification title',
+            'body' => 'Notification body',
+            'sound' => '', // Optional
+	        'icon' => '', // Optional
+	        'click_action' => '' // Optional
+        ])
+        ->setData([
+	        'param' => 'zxy' // Optional
+	    ])
+	    ->setPriority('high'); // Default is 'normal'
+}
+```
+
+## Available methods:
+
+- `getData`: To Set `data`.
+- `getPriority`: To Set `priority`.
+- `getTimeToLive`: To Set `time_to_live`.
+- `getCollapseKey`: To Set `collapse_key`.
+- `getNotification`: To Set `notification`.
+- `getCondition`: To Set `condition`.
+- `getContentAvailable`: To Set `content_available`.
+- `getMutableContent`: To Set `mutable_content`.
+- `getPackageName`: To Set `restricted_package_name`.
+
+When sending to specific device(s), make sure your notifiable entity has `routeNotificationForFirebase` method defined:
+> **Note:** You can send fo many devices by return an array of tokens.
+
+```php
+/**
+ * Route notifications for Firebase channel.
+ *
+ * @return string|array
+ */
+public function routeNotificationForFirebase()
+{
+    return $this->device_tokens;
+}
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.