Skip to content

Commit c673e3b

Browse files
authored
Merge pull request #1 from ika-rwth-aachen/improvement/documentation
Improve documentation
2 parents 929f362 + 6d9e748 commit c673e3b

File tree

3 files changed

+38
-4
lines changed

3 files changed

+38
-4
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Institute for Automotive Engineering of RWTH Aachen University
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# mqtt_client
22

3+
<p align="center">
4+
<img src="https://img.shields.io/badge/ROS1-noetic-green"/></a>
5+
<img src="https://img.shields.io/github/v/release/ika-rwth-aachen/mqtt_client"/></a>
6+
<img src="https://img.shields.io/github/license/ika-rwth-aachen/mqtt_client"/></a>
7+
<img src="https://img.shields.io/github/stars/ika-rwth-aachen/mqtt_client?style=social"/></a>
8+
</p>
9+
310
The *mqtt_client* package provides a ROS nodelet that enables connected ROS-based devices or robots to exchange ROS messages via an MQTT broker using the [MQTT](http://mqtt.org) protocol. This works generically for arbitrary ROS message types.
411

5-
- [Dependencies](#dependencies)
12+
- [Installation](#installation)
613
- [Usage](#usage)
714
- [Quick Start](#quick-start)
815
- [Launch](#launch)
@@ -11,9 +18,15 @@ The *mqtt_client* package provides a ROS nodelet that enables connected ROS-base
1118
- [Package Summary](#package-summary)
1219
- [How It Works](#how-it-works)
1320

14-
## Dependencies
21+
## Installation
22+
23+
The *mqtt_client* package is released as an official ROS Noetic package and can easily be installed via a package manager.
24+
25+
```bash
26+
sudo apt install ros-noetic-mqtt-client
27+
```
1528

16-
After cloning this repository into a ROS workspace, all dependencies that are listed in the ROS [`package.xml`](package.xml) can be installed using [*rosdep*](http://wiki.ros.org/rosdep).
29+
If you would like to install *mqtt_client* from source, simply clone this repository into your ROS workspace. All dependencies that are listed in the ROS [`package.xml`](package.xml) can be installed using [*rosdep*](http://wiki.ros.org/rosdep).
1730

1831
```bash
1932
# mqtt_client$

package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<!-- Url tags are optional, but multiple are allowed, one per tag -->
2222
<!-- Optional attribute type can be: website, bugtracker, or repository -->
2323
<!-- Example: -->
24-
<!-- <url type="website">http://wiki.ros.org/hx_testmanager</url> -->
24+
<url type="website">http://wiki.ros.org/mqtt_client</url>
2525
<url type="repository">https://github.com/ika-rwth-aachen/mqtt_client</url>
2626

2727

0 commit comments

Comments
 (0)