Update README.md
This commit is contained in:
22
README.md
22
README.md
@ -5,14 +5,32 @@
|
||||
[](https://github.com/feross/standard)
|
||||
[](https://gitter.im/lwsjs/local-web-server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
***Requires node v7.6 or higher. Install the [previous release](https://github.com/lwsjs/local-web-server/tree/v1.x) for node >= v4.0.0. Documentation still WIP.***
|
||||
**This documentation is a work in progress**
|
||||
|
||||
# local-web-server
|
||||
|
||||
*Documentation coming soon.*
|
||||
The modular development web server for productive front-end and full-stack engineers. Use this tool to:
|
||||
|
||||
* Help build a web application using any architecture (static website, Single Page Application with client-side rendering, dynamic app with server-side rendering, Progressive Web App etc.)
|
||||
* Prototype a web service (REST API, microservice, websocket server application etc)
|
||||
|
||||
Agnostic which front-end framework (React, Polymer, Angular etc) you use, if any.
|
||||
|
||||
## Synopsis
|
||||
|
||||
This package installs the `ws` command-line tool. The most simple use case is to run `ws` without any arguments - this will host the current directory as a static web site.
|
||||
|
||||
```sh
|
||||
$ ws
|
||||
Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000
|
||||
```
|
||||
|
||||
Being modular and extensible, there are many possibilites how to use this tool for more advanced usage.
|
||||
|
||||
## Install
|
||||
|
||||
Requires node v7.6 or higher. Install the [previous release](https://github.com/lwsjs/local-web-server/tree/v1.x) for node >= v4.0.0.
|
||||
|
||||
```sh
|
||||
$ npm install -g local-web-server@next
|
||||
```
|
||||
|
Reference in New Issue
Block a user