Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amer8 committed Dec 24, 2019
1 parent 6c32486 commit cc1eb19
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 9 deletions.
Binary file added .DS_Store
Binary file not shown.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
![LwMQN Network](https://raw.githubusercontent.com/lwmqn/documents/master/media/lwmqn_net.png)
![LWMQN Network](https://raw.githubusercontent.com/lwmqn/shepherd/master/docs/images/lwmqn.png)

<div align="center">

**@lwmqn/shepherd** is a network server and manager for the Lightweight Message Queuing Network (LwMQN)

[![Greenkeeper badge](https://badges.greenkeeper.io/lwmqn/shepherd.svg?style=flat-square)](https://greenkeeper.io/)
[![NPM version](https://img.shields.io/npm/v/shepherd.svg?style=flat-square)](https://www.npmjs.com/package/shepherd)
[![NPM downloads](https://img.shields.io/npm/dm/shepherd.svg?style=flat-square)](https://www.npmjs.com/package/shepherd)
[![Travis branch](https://img.shields.io/travis/lwmqn/shepherd/master.svg?maxAge=2592000&style=flat-square)](https://travis-ci.org/lwmqn/shepherd)
[![Coverage Status](https://coveralls.io/repos/github/lwmqn/shepherd/badge.svg?branch=master&style=flat-square)](https://coveralls.io/github/lwmqn/shepherd?branch=master)
[![Gitter](https://img.shields.io/gitter/room/lwmqn/Lobby.svg?style=flat-square)](https://gitter.im/lwmqn/Lobby)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)
![pr-welcoming-image](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
Expand Down Expand Up @@ -38,6 +36,10 @@ Lightweight Message Queuing Network ([**LwMQN**](http://lwmqn.github.io)) is an
* Easy to query resources on a Client Device with the URI-style path, and everything has been well-organized to ease the pain for you to create RPC interfaces for your webapps, such as RESTful and websocket-based APIs.
* LwMQN Server is your local machine gateway and application runner. But if you like to let your machines go up cloud, why not? It's Node.js!

### Understanding Smart Objects and the IPSO Model

![IPSO Model](https://raw.githubusercontent.com/lwmqn/shepherd/master/docs/images/ipso_model.png)

#### Acronyms and Abbreviations
* **Server**: LwMQN server
* **Client** or **Client Device**: LwMQN client (machine)
Expand All @@ -56,6 +58,12 @@ Currently [Node.js 8.x LTS](https://nodejs.org/en/about/releases/) or higher is
$ npm install @lwmqn/shepherd
```

### Compabitility table

| Shepherd versions /<br>Node.js versions | 8.x<br>LTS | 10.x<br>LTS | 11.x | 12.x<br>LTS | 13.x |
|--------------------------------------|------------|-------------|------|-------------|------|
| v0.8.0 ||||||

-------

## Basic Usage
Expand Down
10 changes: 5 additions & 5 deletions docs/Basic-APIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Create a server instance of the `LwmqnShepherd` class. This document will use `q
* Create a server and name it

```js
const LwmqnShepherd = require('lwmqn-shepherd')
const qserver = new LwmqnShepherd('my_iot_server')
const Shepherd = require('lwmqn-shepherd')
const qserver = new Shepherd('my_iot_server')
```

* Create a server that starts on a specified port

```js
const qserver = new LwmqnShepherd('my_iot_server', {
const qserver = new Shepherd('my_iot_server', {
broker: {
port: 9000
}
Expand All @@ -47,7 +47,7 @@ const qserver = new LwmqnShepherd('my_iot_server', {
* Create a server with other backend ([example from Mosca wiki](https://github.com/mcollina/mosca/wiki/Mosca-advanced-usage#--mongodb))

```js
const qserver = new LwmqnShepherd('my_iot_server', {
const qserver = new Shepherd('my_iot_server', {
broker: {
port: 1883,
backend: { // backend is the pubsubsettings seen in Mosca wiki page
Expand All @@ -63,7 +63,7 @@ const qserver = new LwmqnShepherd('my_iot_server', {
* Create a server with a default account. Only Clients connecting with this account is authenticated if you don't have an authentication subsystem.

```js
const qserver = new LwmqnShepherd('my_iot_server', {
const qserver = new Shepherd('my_iot_server', {
account: {
username: 'skynyrd',
password: 'lynyrd'
Expand Down
2 changes: 1 addition & 1 deletion docs/Message-Encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Method of decryption. Overridable.
**Encryption/Decryption Example:**

```js
const qserver = new MqttShepherd('my_iot_server')
const qserver = new Shepherd('my_iot_server')

// In this example, I simply encrypt the message with a constant password 'mysecrete'.
// You may like to get the password according to different qnodes by `clientId` if you have
Expand Down
Binary file added docs/images/ipso_model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/lwmqn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cc1eb19

Please sign in to comment.