Skip to content

Commit

Permalink
More package and readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
goldfire committed Feb 14, 2018
1 parent e53a331 commit e1f5877
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
In-process monitoring of distributed Node.js instances over UDP unicast. Simply require democracy in each instance and provide the IP/port for other peers and the rest is taken care of automatically. democracy.js will get the configuration from the other nodes, elect a leader and keep them all in sync. If the active leader becomes unresponsive, the other instances will elect a new leader.

## Installation
```
npm install democracy
```
* Install with [npm](https://www.npmjs.com/package/democracy): `npm install democracy`
* Install with [Yarn](https://yarnpkg.com/en/package/democracy): `yarn add democracy`

## Examples
The below example is easy to run on your local machine (also found in the examples directory). The IP's can just as easily be swapped out for IP's of other servers/instances.
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 8 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "democracy",
"version": "1.3.0",
"description": "Node.js unicast discovery and master-slave elections.",
"homepage": "https://github.com/goldfire/democracy.js",
"keywords": [
Expand All @@ -10,21 +11,21 @@
"leader",
"unicast",
"udp",
"discovery"
"discovery",
"pubsub"
],
"author": "James Simpson <[email protected]> (http://goldfirestudios.com)",
"repository": {
"type": "git",
"url": "git://github.com/goldfire/democracy.js.git"
},
"main": "index.js",
"version": "1.3.0",
"license": {
"type": "MIT",
"url": "https://raw.githubusercontent.com/goldfire/democracy.js/master/LICENSE.md"
"scripts": {
"release": "VERSION=`printf 'v' && node -e 'console.log(require(\"./package.json\").version)'` && git tag $VERSION && git push && git push origin $VERSION && npm publish"
},
"main": "index.js",
"license": "MIT",
"dependencies": {
"uuid": "3.0.*"
"uuid": "3.2.*"
},
"devDependencies": {
"eslint": "4.17.0",
Expand Down

0 comments on commit e1f5877

Please sign in to comment.