Permalink
Browse files

details

  • Loading branch information...
1 parent 4a61871 commit 816a1ee73a45ee034a0044c41ae466db9af13e8f @lloyd committed May 27, 2011
Showing with 34 additions and 8 deletions.
  1. +13 −0 LICENSE
  2. +21 −8 README.md
View
13 LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2011, Lloyd Hilaiel <lloyd@hilaiel.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
View
29 README.md
@@ -8,28 +8,41 @@ will filter JSON on the server. Usage looks like this:
Request before connect-select:
- curl http://localhost/getjson
-
+ $ curl http://localhost/getjson
{
"somethingicarefor": "beer",
"somethingidont": "war"
}
Request after connect-select:
- curl http://localhost/getjson?select=.somethingicarefor
-
+ $ curl http://localhost/getjson?select=.somethingicarefor
["beer"]
## How To Use It
1. npm install connect-select
2. add connect-select to your middleware stack, before your code that
- outputs JSON.
-
- server.use(require('connect-select')());
-
+ outputs JSON: `server.use(require('connect-select')());`
3. write JSON with `resp.writeJSON()`
4. Tell your api clients that they can provide a `select` get parameter to any of your APIs.
If any of that is unclear, check out the example.
+
+## License
+
+(ISC)
+
+Copyright (c) 2011, Lloyd Hilaiel <lloyd@hilaiel.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

0 comments on commit 816a1ee

Please sign in to comment.