From bfad438262fc4edc6b0b7a1e921591a30cca81ec Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Sun, 1 Feb 2015 14:04:17 +0000 Subject: [PATCH] docs --- LICENSE | 21 +++++++++++++++++++++ README.md | 24 +++++++++++++----------- package.json | 1 + 3 files changed, 35 insertions(+), 11 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2abca62 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2015 Lloyd Brookes <75pound@gmail.com> + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 516088d..346aa29 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,20 @@ [![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server) ![Analytics](https://ga-beacon.appspot.com/UA-27725889-12/local-web-server/README.md?pixel) -#local-web-server +# local-web-server Fires up a simple, CORS-enabled, static web server on a given port. Use for local web development or file sharing (directory browsing enabled). ![local-web-server](http://75lb.github.io/local-web-server/ws.gif) -##Install +## Install Ensure [node.js](http://nodejs.org) is installed first. Linux/Mac users may need to run the following commands with `sudo`. -###Globally +### Globally ```sh $ npm install -g local-web-server ``` -###Bundled with your project +### Bundled with your project ```sh $ npm install local-web-server --save-dev ``` @@ -45,7 +45,7 @@ $ npm install $ npm start ``` -##Usage +## Usage ``` Usage $ ws @@ -90,7 +90,7 @@ To add compression, reducing bandwidth, increasing page load time (by 10-15% on $ ws --compress ``` -###Logging +### Logging Passing a value to `--log-format` will write an access log to `stdout`. Either use a built-in [morgan](https://github.com/expressjs/morgan) logger preset: @@ -108,7 +108,7 @@ Or silence: $ ws -f none ``` -##Storing default options +## Storing default options To store per-project options, saving you the hassle of inputting them everytime, store them in the `local-web-server` property of your project's `package.json`: ```json { @@ -144,7 +144,7 @@ To view your stored defaults, run: $ ws --config ``` -##mime-types +## mime-types You can set additional mime-type/extension mappings, or override the defaults by setting a `mime` value in your local config. This value is passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine). Example: ```json @@ -155,10 +155,10 @@ You can set additional mime-type/extension mappings, or override the defaults by } ``` -##Use with Logstalgia +## Use with Logstalgia local-web-server is compatible with [logstalgia](http://code.google.com/p/logstalgia/). -###Install Logstalgia +### Install Logstalgia On MacOSX, install with [homebrew](http://brew.sh): ```sh $ brew install logstalgia @@ -173,7 +173,7 @@ $ ws -f logstalgia | logstalgia - ![local-web-server with logstalgia](http://75lb.github.io/local-web-server/logstagia.gif) -##Use with glTail +## Use with glTail To use with [glTail](http://www.fudgie.org), write your log to disk using the "default" format: ```sh $ ws -f default > web.log @@ -190,3 +190,5 @@ servers: parser: apache color: 0.2, 0.2, 1.0, 1.0 ``` + +© 2015 Lloyd Brookes <75pound@gmail.com> diff --git a/package.json b/package.json index bfd3c53..e752bf5 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "bin": { "ws": "./bin/ws.js" }, + "license": "MIT", "engines": { "node": ">=0.10.0" },