From b387089b3293d5f2cd147944ec43d5a9f7c14587 Mon Sep 17 00:00:00 2001 From: Salman Zafar Date: Fri, 1 Mar 2019 11:36:34 +0500 Subject: [PATCH] Updated Documentation and .json file --- Readme.md | 21 +++++++++++++++++++++ composer.json | 13 ++++++++++++- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 2bf5811..06a102f 100644 --- a/Readme.md +++ b/Readme.md @@ -14,7 +14,28 @@ composer require salmanzafar/laravel-mqtt * Certificate Protection for end to end encryption * Enable Debug mode to make it easier for debugging +## Enable the package (Optional) +This package implements Laravel auto-discovery feature. After you install it the package provider and facade are added automatically for laravel >= 5.5. + +__This step is only required if you are using laravel version <5.5__ + +To declare the provider and/or alias explicitly, then add the service provider to your config/app.php: + +``` +'providers' => [ + + Salman\Mqtt\MqttServiceProvider::class, +]; +``` +And then add the alias to your config/app.php: +``` +'aliases' => [ + + 'Mqtt' => \Salman\Mqtt\Facades\Mqtt::class, +]; +``` ## Configuration +Publish the configuration file ``` php artisan vendor:publish --provider="Salman\Mqtt\MqttServiceProvider" ``` diff --git a/composer.json b/composer.json index c302136..18ec2df 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "salmanzafar/laravel-mqtt", - "description": "A simple MQTT Package to connect/publish/subscribe to a MQTT broker using Laravel 5", + "description": "A simple MQTT Library to connect/publish/subscribe to a MQTT broker using Laravel 5", "type": "library", "license": "MIT", "authors": [ @@ -9,6 +9,17 @@ "email": "salmanzafar949@gmail.com" } ], + "keywords": [ + "laravel", + "laravel5", + "mqtt-laravel", + "mqtt-laravel-publisher", + "mqtt-laravel-subscriber", + "laravel mqtt library", + "laravel-mqtt", + "laravel mqtt", + "mqtt laravel" + ], "require": { "php": ">=5.4.0" },