Permalink
Browse files

Update project metadata.

  • Loading branch information...
1 parent 0776767 commit 161c200017456e02c270c0a6046ec9dbe4c0a336 @jaredhanson committed Jan 23, 2013
Showing with 41 additions and 47 deletions.
  1. +1 −1 LICENSE
  2. +17 −12 Makefile
  3. +12 −27 README.md
  4. +11 −7 package.json
View
@@ -1,6 +1,6 @@
(The MIT License)
-Copyright (c) 2011 Jared Hanson
+Copyright (c) 2012-2013 Jared Hanson
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
View
@@ -1,19 +1,24 @@
-NODE = node
-TEST = ./node_modules/.bin/vows
+SOURCES = lib/**/*.js
+
+# ==============================================================================
+# Node Tests
+# ==============================================================================
+
+VOWS = ./node_modules/.bin/vows
TESTS ?= test/*-test.js
test:
- @NODE_ENV=test NODE_PATH=lib $(TEST) $(TEST_FLAGS) $(TESTS)
+ @NODE_ENV=test NODE_PATH=lib $(VOWS) $(TESTS)
+
+# ==============================================================================
+# Static Analysis
+# ==============================================================================
-docs: docs/api.html
+JSHINT = jshint
-docs/api.html: lib/passport-yammer/*.js
- dox \
- --title Passport-Yammer \
- --desc "Yammer authentication strategy for Passport" \
- $(shell find lib/passport-yammer/* -type f) > $@
+hint: lint
+lint:
+ $(JSHINT) $(SOURCES)
-docclean:
- rm -f docs/*.{1,html}
-.PHONY: test docs docclean
+.PHONY: test hint lint
View
@@ -3,7 +3,13 @@
[Passport](https://github.com/jaredhanson/passport) strategy for authenticating
with [Yammer](https://www.yammer.com/) using the OAuth 2.0 API.
-## Installation
+This module lets you authenticate using Yammer in your Node.js applications.
+By plugging into Passport, Yammer authentication can be easily and
+unobtrusively integrated into any application or framework that supports
+[Connect](http://www.senchalabs.org/connect/)-style middleware, including
+[Express](http://expressjs.com/).
+
+## Install
$ npm install passport-yammer
@@ -37,11 +43,7 @@ For example, as route middleware in an [Express](http://expressjs.com/)
application:
app.get('/auth/yammer',
- passport.authenticate('yammer'),
- function(req, res){
- // The request will be redirected to Yammer for authentication, so
- // this function will not be called.
- });
+ passport.authenticate('yammer'));
app.get('/auth/yammer/callback',
passport.authenticate('yammer', { failureRedirect: '/login' }),
@@ -54,36 +56,19 @@ application:
For a complete, working example, refer to the [login example](https://github.com/jaredhanson/passport-yammer/tree/master/examples/login).
-[![Build Status](https://secure.travis-ci.org/jaredhanson/passport-yammer.png)](http://travis-ci.org/jaredhanson/passport-yammer)
-
## Tests
$ npm install --dev
$ make test
+[![Build Status](https://secure.travis-ci.org/jaredhanson/passport-yammer.png)](http://travis-ci.org/jaredhanson/passport-yammer)
+
## Credits
- [Jared Hanson](http://github.com/jaredhanson)
## License
-(The MIT License)
-
-Copyright (c) 2011 Jared Hanson
-
-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 MIT License](http://opensource.org/licenses/MIT)
-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 SOFTWARE.
+Copyright (c) 2012-2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>
View
@@ -2,14 +2,23 @@
"name": "passport-yammer",
"version": "0.1.1",
"description": "Yammer authentication strategy for Passport.",
- "author": { "name": "Jared Hanson", "email": "jaredhanson@gmail.com", "url": "http://www.jaredhanson.net/" },
+ "keywords": ["passport", "yammer", "auth", "authn", "authentication", "identity"],
"repository": {
"type": "git",
"url": "git://github.com/jaredhanson/passport-yammer.git"
},
"bugs": {
"url": "http://github.com/jaredhanson/passport-yammer/issues"
},
+ "author": {
+ "name": "Jared Hanson",
+ "email": "jaredhanson@gmail.com",
+ "url": "http://www.jaredhanson.net/"
+ },
+ "licenses": [ {
+ "type": "MIT",
+ "url": "http://www.opensource.org/licenses/MIT"
+ } ],
"main": "./lib/passport-yammer",
"dependencies": {
"pkginfo": "0.2.x",
@@ -21,10 +30,5 @@
"scripts": {
"test": "NODE_PATH=lib node_modules/.bin/vows test/*-test.js"
},
- "engines": { "node": ">= 0.4.0" },
- "licenses": [ {
- "type": "MIT",
- "url": "http://www.opensource.org/licenses/MIT"
- } ],
- "keywords": ["passport", "yammer", "auth", "authn", "authentication", "identity"]
+ "engines": { "node": ">= 0.4.0" }
}

0 comments on commit 161c200

Please sign in to comment.