diff --git a/README.md b/README.md index bd606c9..aef9325 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,41 @@ -

+

-

`up`

- -

quick server blocks in one command

+--- +

quick nginx server blocks in one command



+
-> ⚠️ ❌ `up` is not ready for use yet! Do not attempt to use this. +> ⚠️ ❌ `up` is not ready for use yet! Do not attempt to use this!
-**`up`** is a command line application to create nginx server blocks quickly with a single command. +# up + +**`up`** is a command line application that creates nginx server blocks quickly with a single command. + +--- + +## Installation + +You will need to have [_node JS_](https://nodejs.org) and [_nginx_](https://nginx.org) installed. + +> ⚠️ ❌ `up` is not published on npm because it's still in development. If you intend to install it for development, follow these instructions: + +`git clone https://github.com/codefeathers/up-serve` + +`cd up-serve` -You will need to have nodeJS and nginx installed. +`npm install` -https://nodejs.org +`npm install -g` -https://nginx.org +> `up` is now available as a command. --- -### Commands +## Commands `up static ` - Create new static server at current folder. @@ -33,7 +47,7 @@ https://nginx.org --- -### Examples: +## Examples: `up static example.com` will serve a static website from current folder.