diff --git a/README.md b/README.md index e4e29ef..ba4dc6a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # 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] +[![version](https://img.shields.io/npm/v/kill-9.svg)](https://npmjs.org/package/kill-9) +[![downloads](https://img.shields.io/npm/dm/kill-9.svg)](https://npmjs.org/package/kill-9) +[![linux](https://img.shields.io/travis/codenautas/kill-9/master.svg)](https://travis-ci.org/codenautas/kill-9) [![Windows Build][appveyor-image]][appveyor-url] -[![Test Coverage][coveralls-image]][coveralls-url] +[![coverage](https://img.shields.io/coveralls/codenautas/kill-9/master.svg)](https://coveralls.io/r/codenautas/kill-9) +[![dependencies](https://img.shields.io/david/codenautas/kill-9.svg)](https://david-dm.org/codenautas/kill-9) ## Install @@ -13,7 +14,7 @@ a way to kill node process from client navigator. Something like http://yoursite $ npm install kill-9 ``` -## Use it in de client navigator +## Use it in the client navigator ![use kill-9 as a url in the navigator](docs/chromeKill-9.png) @@ -44,7 +45,7 @@ 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. +Once installed you can kill the process typing "kill sentence" in the navigator. Example: ```url @@ -55,12 +56,12 @@ http://thesite.kom/kill-9?pid=12345 #### statement *text default "kill-9"* -The statement that you must type in de url. +The statement that you must type in the 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`` +By default kill-9 uses the real pid obteined from ``pid`` property of ``process`` object: ``process.pid`` #### log *boolean default false* @@ -134,19 +135,12 @@ test_app.use( ## 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. + + Actually options.pid can be a text, but 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/codenautas/kill-9/master.svg?label=linux&style=flat -[travis-url]: https://travis-ci.org/codenautas/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/codenautas/kill-9/master.svg?style=flat -[coveralls-url]: https://coveralls.io/r/codenautas/kill-9 -[downloads-image]: https://img.shields.io/npm/dm/kill-9.svg?style=flat -[downloads-url]: https://npmjs.org/package/kill-9 +