Skip to content
Browse files

Update readme, license, and package.json

  • Loading branch information...
1 parent 4f6ba48 commit d43b2a3741f9312f54221334fdc090cf413d6e98 Steve Veerman committed Sep 29, 2011
Showing with 55 additions and 2 deletions.
  1. +21 −0 LICENSE
  2. +32 −0 README
  3. +2 −2 package.json
View
21 LICENSE
@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2011 Postmedia Network Inc.
+
+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 SOFTWARE.
View
32 README
@@ -0,0 +1,32 @@
+# jsonp-filter
+jsonp filter for the express framework.
+
+## Introduction
+
+The purpose of jsonp-filter is to provide an option to serve the response as jsonp (callback with string input).
+
+## Installing
+
+Just grab [node.js](http://nodejs.org/#download) and [npm](http://github.com/isaacs/npm) and you're set:
+
+ npm install jsonp-filter
+
+Note that jsonp-filter was developed using [CoffeeScript](http://coffeescript.org).
+
+## Using
+
+To utilize jsonp-filter, simply require it and then have the express server use the setupJSONP() method. To make sure that no other modules conflict with jsonp-filter, it should be used by the server before other 'use' methods.
+
+ jsonp = require 'jsonp-filter'
+
+ server.use jsonp.setupJSONP()
+
+After jsonp-filter has been setup, responses can now be served as jsonp by specifying json=true&callback=callbackname as query string parameters.
+
+## Outstanding Issues
+
+* none at this time
+
+## Created by
+
+* Stephen Veerman
View
4 package.json
@@ -11,8 +11,8 @@
"licenses": [
{ "type": "MIT", "url": "https://github.com/Postmedia/connect-esi/blob/master/LICENSE"}
],
- "keywords": ["coffeescript", "connect", "json", "jsonp"],
- "repository": "git://github.com/Postmedia/connect-esi",
+ "keywords": ["coffeescript", "express", "json", "jsonp"],
+ "repository": "git://github.com/Postmedia/jsonp-filter",
"main": "./lib/jsonp-filter",
"scripts": {
"build": "cake build"

0 comments on commit d43b2a3

Please sign in to comment.
Something went wrong with that request. Please try again.