hapi-rest-methods - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "hapi-rest-methods",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Add REST HTTP methods directly to server object of hapi.JS framework to easily add routes",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

 # hapi-rest-methods
-Add REST HTTP methods directly to server object of hapi.JS framework to easily add routes
+Add REST HTTP methods directly to server object of hapi.JS framework to easily add routes.
+
+[![Build Status](https://secure.travis-ci.org/daraosn/hapi-rest-methods.png)](http://travis-ci.org/daraosn/hapi-rest-methods)
+
+## Usage
+Coming from ExpressJS and trying not to look back into it, I was introduced to HapiJS, which is a nice alternative, but routes definition is an overkill, I like simplicity of ExpressJS, so I hooked some handy methods to the hapi server object.
+
+Instead of doing:
+
+```
+server.route({
+  type: 'GET',
+  path: '/foo',
+  handler: function(request, reply) {
+    reply('bar');
+  });
+});
+```
+
+You can just do:
+
+```
+server.get('/foo', function(request, reply) {
+  reply('bar');
+});
+```
+
+Simple.
+
+It also supports `post()`, `put()`, `patch()`, `delete()` and `options()`.
+
+
+## Usage
+
+Simple usage:
+```
+  // new hapi server
+  var hapi = require('hapi');
+  var restMethods = require('../')
+  var server = new hapi.Server();
+  server.connection({ port: 8080 });
+  // add hapi-rest-methods plugin
+  server.register(restMethods);
+  // keep. it. simple. stupid. :-)
+  server.get('/fruit', function(request, reply) {
+    reply('orange');
+  });
+  server.post('/grumpy', function(request, reply) {
+    console.log(request.payload.name)
+    reply('cat');
+  });
+```
+
+Plays well with other plugins, such as hapi [inert](https://github.com/hapijs/inert):
+```
+  var inert = require('inert');
+  ...
+  server.register(restMethods);
+  server.register(inert);
+  server.get('/', { file: 'public/index.html' });
+```
+
+## Issues & Contributing
+
+Use [github issues](https://github.com/daraosn/hapi-rest-methods/issues).
+
+## License
+
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5242

increased by43.66%

Number of package files

8

increased by14.29%

Number of lines in readme file

70

increased by2233.33%

No dependency changes