From 56fda3de2c82602f445b9470f10d20f543a346c3 Mon Sep 17 00:00:00 2001 From: Zalmoxisus Date: Thu, 21 Jan 2016 11:16:46 +0200 Subject: [PATCH] Specify about using as npm script --- README.md | 12 ++++++++++++ package.json | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c5f996..767b5dd 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,18 @@ npm install --save-dev remotedev-server ### Usage +Add in your app's `package.json`: + +``` +"scripts": { + "remotedev": "remotedev --hostname=localhost --port=8000" +} +``` + +So, you can start local server by running `npm run remotedev`. + +If you install the package globally (not recommended) just run: + ``` remotedev --hostname=localhost --port=8000 ``` diff --git a/package.json b/package.json index 4f9c790..ae73090 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "remotedev-server", "version": "0.0.1", - "description": "Run remotedev monitor on your local server.", + "description": "Run the RemoteDev monitor on your local server.", "bin": { "remotedev": "bin/remotedev.js" },