Allow git2consul global package installation

breser · Apr 6, 2016 · a81e08e · a81e08e
1 parent 18c2323
commit a81e08e
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ coverage
 reports
 node_modules
 .idea
+*.iml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+v0.12.11
+
+* Allow git2consul global package installation with `npm install -g git2consul`.
+
 v0.12.10
 
 * Ensure that config_reader.read() runs after config_seeder.set() [GH-69]

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ git2consul takes one or many git repositories and mirrors them into [Consul](htt
 
 #### Installation
 
-`npm install git2consul`
+`npm install -g git2consul`
 
 #### Mailing List
 
@@ -50,13 +50,13 @@ EOF
 Start git2consul:
 
 ```
-node . --config-file /tmp/git2consul.json
+git2consul --config-file /tmp/git2consul.json
 ```
 
 or for remote Consul endpoint:
 
 ```
-node . --endpoint remote.consul.host --port 80 --config-file /tmp/git2consul.json
+git2consul --endpoint remote.consul.host --port 80 --config-file /tmp/git2consul.json
 ```
 
 git2consul will now poll the "dev" branch of the "git2consul_data.git" repo once per minute.  On first run, it will mirror the 3 files into your Consul K/V with keys:
@@ -154,7 +154,7 @@ There are environment variable equivalents for the parameters that git2consul ac
 By default, git2consul looks for its configuration at the Consul Key `git2consul/config`.  You can override this with a `-c` of `--config_key` command line switch, like so:
 
 ```sh
-node . -c git2consul/alternative_config
+git2consul -c git2consul/alternative_config
 ```
 
 ##### No Daemon

diff --git a/index.js b/index.js
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 var util = require('util');
 
 var git2consul = require('./lib');
diff --git a/package.json b/package.json
@@ -33,6 +33,8 @@
     "should": "3.3.2",
     "xunit-file": "0.0.5"
   },
+  "preferGlobal": true,
+  "bin": "./index.js",
   "scripts": {
     "test": "./node_modules/.bin/_mocha --reporter spec -t 10000 test | bunyan",
     "cov": "`npm bin`/istanbul cover --root . -x node_modules -x test --dir ./reports `npm bin`/_mocha -- --reporter spec -t 10000 test | bunyan",
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ coverage @@
     reports
     node_modules
     .idea
+    *.iml