kill-9 - npm Package Compare versions

Comparing version 0.1.6 to 0.1.7

package.json

 {
   "name": "kill-9",
   "description": "A way for kill node server from client navigator",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "author": "Emilio Platzer <[e-mail]>",
@@ -6,0 +6,0 @@ "license": "GPL-2.0",

README.md

 # kill-9
 a way to kill node process from client navigator. Something like http://yoursite.kom/kill-9
+
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
+[![Linux Build][travis-image]][travis-url]
+[![Windows Build][appveyor-image]][appveyor-url]
+[![Test Coverage][coveralls-image]][coveralls-url]
+
+## Install
+
+```sh
+$ npm install kill-9
+```
+
+## Use it in de client navigator
+
+![use kill-9 as a url in the navigator](docs/chromeKill-9.png)
+
+## API
+
+```js
+var express = require('express');
+var app = express();
+
+var kill9 = require('kill-9');
+
+var server = app.listen(3000, function() {
+    console.log('Listening on port %d', server.address().port);
+});
+
+app.use(kill9({log:true}));
+
+// complete example: 
+function site_up(req,res){
+    var kill_url='kill-9?pid='+process.pid;
+    res.send("<h1>kill-9 demo</h1><p>site up<p>try <a href="+kill_url+">"+kill_url+"</a>");
+}
+
+app.get('/index.html',site_up);
+app.get('/',site_up);
+```
+
+### ``kill9([options])``
+
+Returns a function middleware to use with ``express.use``. 
+Once installed you can kill de process typing de "kill sentence" in the navigator.
+Example:
+
+```url
+http://thesite.kom/kill-9?pid=12345
+
+### ``options``
+
+#### statement *text default "kill-9"*
+
+The statement that you must type in de url. 
+
+#### pid *integer default process.pid*
+
+The pid value that you must pass in the pid parameter. 
+By default kill-9 uses de real pid obteined from ``pid`` property of ``process`` object: ``process.pid``
+
+#### pid *text default process.pid*
+
+The pid value that you must pass in the pid parameter. 
+By default kill-9 uses de real pid obteined from ``pid`` property of ``process`` object: ``process.pid``
+
+## Notes
+
+ + **This is not secure in production servers. Use it only in developer servers**. Kill-9 lacks of password or validate user or any way for confirm legal use.
+ + Actually options.pid can be a text, buy I don't know if this will change in the future. 
+
+## License
+
+[GPL-2.0](LICENSE)
+
+[npm-image]: https://img.shields.io/npm/v/kill-9.svg?style=flat
+[npm-url]: https://npmjs.org/package/kill-9
+[travis-image]: https://img.shields.io/travis/emilioplatzer/kill-9/master.svg?label=linux&style=flat
+[travis-url]: https://travis-ci.org/emilioplatzer/kill-9
+[appveyor-image]: https://img.shields.io/appveyor/ci/emilioplatzer/kill-9/master.svg?label=windows&style=flat
+[appveyor-url]: https://ci.appveyor.com/project/emilioplatzer/kill-9
+[coveralls-image]: https://img.shields.io/coveralls/emilioplatzer/kill-9/master.svg?style=flat
+[coveralls-url]: https://coveralls.io/r/emilioplatzer/kill-9
+[downloads-image]: https://img.shields.io/npm/dm/kill-9.svg?style=flat
+[downloads-url]: https://npmjs.org/package/kill-9

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

22446

increased by13.15%

Number of lines in readme file

88

increased by2833.33%

No dependency changes