readme
This commit is contained in:
13
README.md
13
README.md
@ -5,7 +5,7 @@
|
||||
|
||||
local-web-server
|
||||
================
|
||||
Fires up a simple, static web server on a given port. Use for local web development or file sharing (directory browsing enabled).
|
||||
Fires up a simple, CORS-enabled, static web server on a given port. Use for local web development or file sharing (directory browsing enabled).
|
||||
|
||||

|
||||
|
||||
@ -13,23 +13,26 @@ Install
|
||||
-------
|
||||
Ensure [node.js](http://nodejs.org) is installed first. Linux/Mac users may need to run the following commands with `sudo`.
|
||||
|
||||
##As a global command
|
||||
##Globally
|
||||
```sh
|
||||
$ npm install -g local-web-server
|
||||
```
|
||||
|
||||
##As a server deployed with your project
|
||||
##Deployed with your project
|
||||
```sh
|
||||
$ npm install local-web-server --save-dev
|
||||
```
|
||||
|
||||
Then add an `npm start` script to your `package.json`, the standard npm approach:
|
||||
Then add an `start` script to your `package.json` (the standard npm approach):
|
||||
```json
|
||||
{
|
||||
"name": "my-web-app",
|
||||
"version": "1.0.0",
|
||||
"scripts": {
|
||||
"start": "ws"
|
||||
}
|
||||
```
|
||||
This simplifies a set of rather specific looking install instructions like:
|
||||
This simplifies a rather specific looking instruction set like:
|
||||
|
||||
```sh
|
||||
$ npm install
|
||||
|
Reference in New Issue
Block a user