initial commit
setting up the project
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal file
@ -0,0 +1,29 @@
|
||||
# php-mqtt/laravel-client
|
||||
|
||||
`php-mqtt/laravel-client` was created by, and is maintained by [Namoshek](https://github.com/namoshek).
|
||||
It is a Laravel wrapper for the [`php-mqtt/client`](https://github.com/php-mqtt/client) package and
|
||||
allows you to connect to an MQTT broker where you can publish messages and subscribe to topics.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
composer require php-mqtt/laravel-client
|
||||
```
|
||||
|
||||
You should then publish the configuration file using
|
||||
|
||||
```bash
|
||||
php artisan vendor:publish --provider="PhpMqtt\Client\MqttClientServiceProvider"
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
// TODO: usage
|
||||
|
||||
## Features
|
||||
|
||||
This library allows you to use all the features provided by [`php-mqtt/client`](https://github.com/php-mqtt/client).
|
||||
|
||||
## License
|
||||
|
||||
`php-mqtt/laravel-client` is open-sourced software licensed under the [MIT license](LICENSE.md).
|
Reference in New Issue
Block a user