gitban - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

lib/index.js

@@ -12,2 +12,3 @@ var LBL_BACKLOG = 'GB0 - Backlog';
 var _fs = require('fs');
+var _pjson = require('../package.json');
 
@@ -17,3 +18,3 @@ loadDefaults();
 _prg
-    .version('0.0.1')
+    .version(_pjson.version)
     .option('-u, --user <username>', 'login user name')
@@ -23,3 +24,3 @@ .option('-p, --pass <password>', 'login password')
     .option('-o, --org <organization>', 'organization')
-    .option('-t, --token <token>', 'OAuth token to use.  User/Pass are ignored.')
+    .option('-t, --token <token>', 'OAuth token to use.  Password is ignored.')
     .option('-a, --assignee <assignee>', 'assignee or "all" for all users, default is login user');
@@ -26,0 +27,0 @@

package.json

 {
 	"name": "gitban",
-	"version" : "0.0.3",
+	"version" : "0.0.4",
 	"description": "Very simple command line kanban-esque tool for use with github issues",
@@ -5,0 +5,0 @@ "author": "Pete Diemert <[e-mail]>",

README.md

@@ -8,3 +8,3 @@ gitban
 
-    npm install gitban
+    npm install gitban -g
   
@@ -32,3 +32,3 @@ Next, create the following labels in your github project:
 
-These can be put in a file called .gitban.json in your home directory for convenience. The format is:
+These can be put in a file called *.gitban.json* in your home directory for convenience. The format is:
 
@@ -42,4 +42,40 @@ {
     
-The options set in .gitban.json will be overridden by anything specified explicitly on the command line.
+The options set in *.gitban.json* will be overridden by anything specified explicitly on the command line.
 
+Note:  For better security you may wish to not use basic authentication but instead use OAuth.  To do this
+you must first create a an OAuth token with the following command line:
+
+    curl -u '<your github login name>' -d '{"scopes":"repo","note":"gitban"}' https://api.github.com/authorizations
+    
+You will be prompted to login then you should see some JSON that looks like:
+
+    {
+      "token": "<your new OAuth token>",
+      "note": "gitban",
+      "note_url": null,
+      "scopes": [
+        "repo"
+      ],
+      "created_at": "2012-06-28T04:57:16Z",
+      "app": {
+        "url": "http://developer.github.com/v3/oauth/#oauth-authorizations-api",
+        "name": "gitban (API)"
+      },
+      "url": "https://api.github.com/authorizations/437559",
+      "id": 437559,
+      "updated_at": "2012-06-28T04:57:16Z"
+    }
+    
+Now just edit your *.gitban.json* file as follows:
+
+    {
+        "token" : "<your new token from above>",
+        "user" : "username",
+        "org" : "organization",
+        "repo" : "repository"
+    }
+    
+Done!  From this point forward you can manage (e.g. revoke) this token using the Organizations tab from within
+your github account settings.
+
 ###Workflow
@@ -46,0 +82,0 @@

No alert changes

Improved metrics

Total package byte prevSize

35472

increased by3.94%

Lines of code

358

increased by0.28%

Number of lines in readme file

134

increased by36.73%

No dependency changes