Skip to content

Commit

Permalink
update README and License
Browse files Browse the repository at this point in the history
  • Loading branch information
esatterwhite committed Dec 30, 2016
1 parent bcbaa01 commit 601e903
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 6 deletions.
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2016 Eric Satterwhite

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
[![Travis](https://img.shields.io/travis/esatterwhite/skyring.svg?style=flat-square)](https://travis-ci.org/esatterwhite/skyring)
[![npm](https://img.shields.io/npm/v/skyring.svg?style=flat-square)](https://www.npmjs.com/package/skyring)
[![npm](https://img.shields.io/npm/l/skyring.svg?style=flat-square)](https://www.npmjs.com/package/skyring)
[![David](https://img.shields.io/david/esatterwhite/skyring.svg)](https://david-dm.org/esatterwhite/skyring)
[![David](https://img.shields.io/david/esatterwhite/skyring.svg?style=flat-square)](https://david-dm.org/esatterwhite/skyring)
[![Docker Repository on Quay](https://quay.io/repository/esatterwhite/skyring/status "Docker Repository on Quay")](https://quay.io/repository/esatterwhite/skyring)

# Skyring
A distributed reliable timer service providing similar functionality to using `setTimeout`.
Expand Down Expand Up @@ -82,7 +83,7 @@ That is it! You have a 5 node **Skyring** cluster with a 3 node `nats` cluster b
## Run A Local Cluster

#### Start a nats instance
Down load the [nats binary](https://github.com/nats-io/gnatsd/releases) and start it using the defaults
Download the [nats binary](https://github.com/nats-io/gnatsd/releases) and start it using the defaults

```bash
$ gnats -D -V
Expand Down
11 changes: 7 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
"version": "2.0.1",
"description": "Distributed timers as a service",
"main": "index.js",
"bin": {
"skyring": "./bin/skyring.js"
},
"scripts": {
"test": "node ./test.js",
"start": "npm run compose:up",
Expand All @@ -21,6 +18,13 @@
"type": "git",
"url": "hhttps://github.com/esatterwhite/skyring"
},
"engines": {
"node": ">=6.0.0"
},
"bugs": {
"email": "[email protected]",
"url": "https://github.com/esatterwhite/skyring/issues"
},
"dependencies": {
"body": "^5.1.0",
"debug": "^2.2.0",
Expand All @@ -29,7 +33,6 @@
"path-to-regexp": "^1.7.0",
"request": "^2.76.0",
"ringpop": "^10.16.2",
"seeli": "^3.0.1",
"tchannel": "^3.9.0",
"uuid": "^3.0.1"
},
Expand Down

0 comments on commit 601e903

Please sign in to comment.