From ddd413687e2c7c79f81c765ec4b549b360d1b223 Mon Sep 17 00:00:00 2001 From: Florian Ludwig Date: Sat, 13 Mar 2021 14:53:37 +0100 Subject: [PATCH] README update --- readme.rst | 71 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 46 insertions(+), 25 deletions(-) diff --git a/readme.rst b/readme.rst index 8cf91bc..51b7f9b 100644 --- a/readme.rst +++ b/readme.rst @@ -1,12 +1,43 @@ -HBMQTT +.. image:: https://img.shields.io/github/license/Yakifo/amqtt?style=flat-square + +.. image:: https://img.shields.io/github/workflow/status/Yakifo/amqtt/Python%20package?style=flat-square + :target: https://github.com/Yakifo/amqtt/actions/workflows/python-package.yml + + +.. + + TODO + image:: https://coveralls.io/repos/beerfactory/hbmqtt/badge.svg?branch=master&service=github + :target: https://coveralls.io/github/beerfactory/hbmqtt?branch=master + + + +.. + + TODO + image:: https://readthedocs.org/projects/hbmqtt/badge/?version=latest + :target: http://hbmqtt.readthedocs.org/en/latest/?badge=latest + :alt: Documentation Status + + +.. image:: https://img.shields.io/gitter/room/Yakifo/amqtt?style=flat-square + :target: https://gitter.im/amqtt/community + :alt: 'Join the chat at https://gitter.im/amqtt/community' + + +AMQTT ====== -``HBMQTT`` is an open source `MQTT`_ client and broker implementation. +``AMQTT`` is an open source `MQTT`_ client and broker implementation. -Built on top of `asyncio`_, Python's standard asynchronous I/O framework, HBMQTT provides a straightforward API +Built on top of `asyncio`_, Python's standard asynchronous I/O framework, AMQTT provides a straightforward API based on coroutines, making it easy to write highly concurrent applications. +It was forked from `HBMQTT`_ after it was deprecated by the original author. + + .. _asyncio: https://docs.python.org/3/library/asyncio.html +.. _HBMQTT: https://github.com/beerfactory/hbmqtt Features -------- @@ -21,43 +52,33 @@ HBMQTT implements the full set of `MQTT 3.1.1`_ protocol specifications and prov - SSL support over TCP and websocket - Plugin system -Build status ------------- -.. image:: https://travis-ci.org/beerfactory/hbmqtt.svg?branch=master - :target: https://travis-ci.org/beerfactory/hbmqtt +Project Status and Roadmap +--------------------------- -.. image:: https://coveralls.io/repos/beerfactory/hbmqtt/badge.svg?branch=master&service=github - :target: https://coveralls.io/github/beerfactory/hbmqtt?branch=master +The current focus is to build setup the project infrastructure for the new fork. +From there the goal is to fix outstanding known issues and clean up the code. -Project status --------------- +- `0.10.x` will keep using the `hbmqtt` module name and aims to be a drop-in replacement to `hbmqtt` +- `0.11.x` will use `amqtt` as module name -.. image:: https://readthedocs.org/projects/hbmqtt/badge/?version=latest - :target: http://hbmqtt.readthedocs.org/en/latest/?badge=latest - :alt: Documentation Status - -.. image:: https://badge.fury.io/py/hbmqtt.svg - :target: https://badge.fury.io/py/hbmqtt Getting started --------------- -hbmqtt is available on `Pypi `_ and can installed simply using ``pip`` : +`amqtt` is available on `Pypi `_ and can installed simply using ``pip`` : :: - $ pip install hbmqtt + $ pip install amqtt Documentation is available on `Read the Docs`_. Bug reports, patches and suggestions welcome! Just `open an issue`_ or join the `gitter channel`_. -.. image:: https://badges.gitter.im/Join%20Chat.svg - :target: https://gitter.im/beerfactory/hbmqtt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge - :alt: 'Join the chat at https://gitter.im/beerfactory/hbmqtt' + .. _MQTT: http://www.mqtt.org .. _MQTT 3.1.1: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html -.. _Read the Docs: http://hbmqtt.readthedocs.org/ -.. _open an issue: https://github.com/beerfactory/hbmqtt/issues/new -.. _gitter channel: https://gitter.im/beerfactory/hbmqtt +.. _Read the Docs: http://amqtt.readthedocs.org/ +.. _open an issue: https://github.com/Yakifo/amqtt/issues/new +.. _gitter channel: https://gitter.im/amqtt/community