Skip to content

Commit

Permalink
docs: Plugins and features table
Browse files Browse the repository at this point in the history
  • Loading branch information
robertsLando committed Jan 21, 2020
1 parent ff75c4d commit 7ef4ae3
Showing 1 changed file with 42 additions and 2 deletions.
44 changes: 42 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,23 @@
[![NPM version](https://img.shields.io/npm/v/aedes.svg?style=flat)](https://www.npmjs.com/package/aedes)
[![NPM downloads](https://img.shields.io/npm/dm/aedes.svg?style=flat)](https://www.npmjs.com/package/aedes)

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

Barebone MQTT server that can run on any stream server.

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
| QoS 0 | QoS 1 | QoS 2 | auth | [bridge][bridge_protocol] | $SYS topics | SSL | [dynamic topics][dynamic_topics] | cluster | websockets | plugin system | MQTT 5 |
| ----- | ----- | ----- | ---- | ------------------------- | ----------- | --- | -------------------------------- | ------- | ---------- | ------------- | ------ |
||||| ? ||||||||

* [Install](#install)
* [Example](#example)
* [API](#api)
* [TODO](#todo)
* [Plugins](#plugins)
* [Collaborators](#collaborators)
* [Acknowledgements](#acknowledgements)
* [License](#license)


<a name="install"></a>
## Install
To install aedes, simply use npm:
Expand Down Expand Up @@ -60,6 +64,29 @@ server.listen(8883, function () {
})
```

### WEBSOCKETS

```js
var aedes = require('./aedes')()
var server = require('net').createServer(aedes.handle)
var httpServer = require('http').createServer()
var ws = require('websocket-stream')
var port = 1883
var wsPort = 8888

server.listen(port, function () {
console.log('server listening on port', port)
})

ws.createServer({
server: httpServer
}, aedes.handle)

httpServer.listen(wsPort, function () {
console.log('websocket server listening on port', wsPort)
})
```

<a name="api"></a>
## API

Expand Down Expand Up @@ -475,6 +502,16 @@ You can subscribe on the following `$SYS` topics to get client presence:
- `$SYS/+/disconnect/clients` - will inform about client disconnections.
The payload will contain the `clientId` of the connected/disconnected client
## Plugins
- [aedes-persistence](https://github.com/moscajs/aedes-persistence): In-memory implementation of an Aedes persistence
- [aedes-persistence-mongodb](https://github.com/moscajs/aedes-persistence-mongodb): MongoDB persistence for Aedes
- [aedes-persistence-redis](https://github.com/moscajs/aedes-persistence-redis): Redis persistence for Aedes
- [aedes-persistence-level](https://github.com/moscajs/aedes-persistence-level): LevelDB persistence for Aedes
- [aedes-persistence-nedb](https://github.com/ovhemert/aedes-persistence-nedb#readme): NeDB persistence for Aedes
- [aedes-logging](https://github.com/moscajs/aedes-logging): Logging module for Aedes, based on Pino
- [aedes-stats](https://github.com/moscajs/aedes-stats): Stats for Aedes
## Collaborators
* [__Gavin D'mello__](https://github.com/GavinDmello)
Expand All @@ -491,3 +528,6 @@ stability.
## License
MIT
[dynamic_topics]: https://github.com/mqtt/mqtt.github.io/wiki/are_topics_dynamic
[bridge_protocol]: https://github.com/mqtt/mqtt.github.io/wiki/bridge_protocol

0 comments on commit 7ef4ae3

Please sign in to comment.