Restructure docs, add basic contribution guide

Author: yamalight

README.md

@@ -1,33 +1,24 @@
-# Exoframe (beta)
+# Exoframe
 
-> Power armor for docker containers
+> Simple Docker deployment tool
 
 [![Build Status](https://travis-ci.org/exoframejs/exoframe.svg?branch=master)](https://travis-ci.org/exoframejs/exoframe)
 [![Coverage Status](https://coveralls.io/repos/github/exoframejs/exoframe/badge.svg?branch=master)](https://coveralls.io/github/exoframejs/exoframe?branch=master)
 [![npm](https://img.shields.io/npm/v/exoframe.svg?maxAge=2592000)](https://www.npmjs.com/package/exoframe)
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://opensource.org/licenses/MIT)
 
-[![asciicast](https://asciinema.org/a/129255.png)](https://asciinema.org/a/129255)
-
-## How it works
-
-Exoframe intends to do all the heavy lifting required to build and deploy web services for you.  
-Exoframe uses [Docker](https://www.docker.com/) to deploy your project and [Traefik](https://traefik.io/) to proxy them to requested domain and/or paths.  
-All the configuration of your projects happens automatically. So after running the command, the only thing you need to do is wait a few seconds until your files have been built or deployed!
+Exoframe is a self-hosted tool that allows simple one-command deployments using Docker.
 
-Currently, Exoframe understands and can deploy the following project types:
+## Demo
 
-1. Static html based projects - will be deployed using [nginx](http://hub.docker.com/_/nginx) image
-2. Node.js based projects - will be deployed using [Node:latest](https://hub.docker.com/_/node) image
-3. Docker based project - will be deployed using your [Dockerfile](https://docs.docker.com/engine/reference/builder/)
-4. Docker-Compose based project - will be deployed using your [docker-compose](https://docs.docker.com/compose/compose-file/) file
-
-To run Exoframe you need two parts - Exoframe CLI on your local machine and [Exoframe server](https://github.com/exoframejs/exoframe-server) on your server with Docker.
+[![asciicast](https://asciinema.org/a/129255.png)](https://asciinema.org/a/129255)
 
 ## Installation and Usage
 
-You can use one of the pre-packaged binaries from [releases](https://github.com/exoframejs/exoframe/releases).  
-Or if you have Node installed, you can install Exoframe CLI using NPM (needs at least Node 8.0):
+To run Exoframe you will need two parts - Exoframe CLI and [Exoframe server](https://github.com/exoframejs/exoframe-server).  
+For server install instructions see [Exoframe server repository](https://github.com/exoframejs/exoframe-server).
+
+To install Exoframe CLI you can either download one of the pre-packaged binaries from [releases page](https://github.com/exoframejs/exoframe/releases) or install it using npm (needs at least Node 8.x):
 
 ```
 npm install exoframe -g
@@ -45,7 +36,7 @@ Then login using:
 exoframe login
 ```
 
-Then deploy your project by simply running:
+Then you will be able to deploy your projects by simply running:
 
 ```
 exoframe
@@ -55,16 +46,7 @@ You can find a list of all commands and options in the [docs](./docs/README.md).
 
 ## Docs
 
-You can find project documentation [here](./docs/README.md).
-
-## Contribute
-
-1. Fork this repository to your own GitHub account and then clone it to your local device.
-2. Uninstall exoframe if it's already installed: `npm uninstall exoframe -g`
-3. Link it to the global module directory: `npm link`
-4. Transpile the source code and watch for changes: `npm start`
-
-Now can use the `exoframe` command everywhere.
+You can find project documentation in the [docs folder](./docs/README.md).
 
 ## License
 

docs/Basics.md

@@ -25,13 +25,13 @@ It is recommended to run Exoframe on a server with at least 1GB of RAM.
 | deploy [path]          | Deploy specified path |
 | config                 | Generate or update project config for current path |
 | list                   | List currently deployed projects |
-| rm [id]                | Remove existing deployment or project |
-| log [id]               | Get logs for existing deployment or project |
+| rm <id>                | Remove existing deployment or project |
+| log <id>               | Get logs for existing deployment or project |
 | token [ls|rm]          | Generate, list or remove deployment tokens |
 | login                  | Login into Exoframe server |
 | endpoint [url]         | Selects or adds the endpoint of Exoframe server |
 | rm-endpoint [url]      | Removes an existing endpoint of Exoframe server |
-| update [target]        | Gets current versions or updates given target |
+| update [target]        | Gets current versions or updates given target (server | traefik | all) |
 | completion             | Generates bash completion script  |
 
 ## Project config file

docs/Contributing.md

@@ -0,0 +1,21 @@
+## I want to contribute
+
+Awesome! All contributions are welcome.  
+If you want to add new feature or implement a significant change that hasn't been discussed yet - please _open an issue first_!
+
+## How to send pull requests
+
+1. Fork this repository to your own GitHub account
+2. Create new branch that is named accordingly to the issue you are working on (e.g. `feature/new-thing` or `fix/bug-name`)
+3. Make sure tests are passing (if you are adding new feature - add tests to cover basics of that feature)
+4. Make sure your branch is up to date with `develop` branch
+5. Open pull request towards `develop` branch
+6. Wait for feedback
+
+## How to run Exoframe CLI locally
+
+1. Fork this repository to your own GitHub account and then clone it to your local device.
+2. Uninstall exoframe if it's already installed: `npm uninstall exoframe -g`
+3. Link it to the global module directory: `npm link`
+
+Now can use the `exoframe` command everywhere.

docs/FAQ.md

@@ -1,11 +1,20 @@
 # FAQ
 
+### Is it ready for production?
+
+Yes. We've been using it to deploy our project since May 2017 without any issues.  
+
 ### Why do I need to enter username during login?
 
 Username is just your ID that is used to distinguish your deployments from others.  
 Right now you have to enter it yourself. And you will only see deployments done with that username.  
 Currently, more than one user can use same username (so, all users with that username will see same deployments).
 
+### How does it work?
+
+Exoframe uses [Docker](https://www.docker.com/) to deploy your project and [Traefik](https://traefik.io/) to proxy requested domains and/or paths to deployed projects.  
+All the Docker configuration of your projects happens automatically. So after running the command, the only thing you need to do is wait a few seconds until your project have been built and deployed!
+
 ### What kind of projects can I deploy with Exoframe?
 
 Currently, Exoframe understands and can deploy the following project types: