Merge branch 'master' into daemon/#174-websockets

README.md

@@ -20,6 +20,14 @@
     <img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg" />
   </a>
 
+  <a href="https://godoc.org/github.com/ubclaunchpad/inertia">
+    <img src="https://godoc.org/github.com/ubclaunchpad/inertia?status.svg">
+  </a>
+
+  <a href="https://microbadger.com/images/ubclaunchpad/inertia">
+    <img src="https://img.shields.io/microbadger/image-size/ubclaunchpad/inertia.svg" />
+  </a>
+
   <a href="https://github.com/ubclaunchpad/inertia/releases">
     <img src="https://img.shields.io/github/release/ubclaunchpad/inertia.svg" />
   </a>
@@ -41,7 +49,7 @@
 
 <br>
 
-Inertia is a simple cross-platform command line application that enables quick and easy setup and management of continuous, automated deployment of a variety of project types on any virtual private server. The project is used, built, and maintained with :heart: by [UBC Launch Pad](https://www.ubclaunchpad.com/).
+Inertia is a simple cross-platform command line application that enables quick and easy setup and management of continuous, automated deployment of a variety of project types on any virtual private server. The project is used, built, and maintained with :heart: by [UBC Launch Pad](https://www.ubclaunchpad.com/), UBC's student-run software engineering club.
 
 |   | Main Features  |
 ----|-----------------

client/README.md

@@ -1,6 +1,6 @@
 # Client
 
-[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/client)
+[![GoDoc](https://godoc.org/github.com/ubclaunchpad/inertia?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/client)
 
 This package contains Inertia's clientside configuration and interface to remote Inertia daemons. It can be imported for use if you don't like the CLI - for example:
 

daemon/README.md

@@ -1,6 +1,6 @@
 # Daemon
 
-[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertiad/daemon/)
+[![GoDoc](https://godoc.org/github.com/ubclaunchpad/inertia?status.svg)](https://godoc.org/github.com/ubclaunchpad/inertia/daemon/inertiad)
 
 This directory contains the Inertia daemon's two components:
 

daemon/inertiad/cmd.go

@@ -64,7 +64,7 @@ Created using an RSA private key.`,
 }
 
 var rootCmd = &cobra.Command{
-	Use:     "inertia",
+	Use:     "inertiad",
 	Short:   "The inertia daemon CLI",
 	Version: getVersion(),
 }

daemon/inertiad/doc.go

@@ -0,0 +1,19 @@
+/*
+
+Inertiad is Inertia's daemon component.
+
+This service runs in the background on your remote VPS and allows you to monitor
+and control your deployed application.
+
+Even though it is built as command line application, inertiad not intended for
+direct use - the Inertia daemon is supposed to be deployed as a Docker container,
+the image for which can be found here:
+https://hub.docker.com/r/ubclaunchpad/inertia/
+
+When used, however, it offers two main commands:
+
+	inertiad token   # generates and outputs a JWT in stdout
+	inertiad run     # starts daemon service
+
+*/
+package main

doc.go

@@ -0,0 +1,59 @@
+/*
+
+Inertia is the command line interface that helps you set up your remote for
+continuous deployment and allows you to manage your deployment through
+configuration options and various commands.
+
+It can be installed in several ways:
+
+	# Mac users
+	brew install ubclaunchpad/inertia
+
+	# Windows users
+	scoop bucket add ubclaunchpad https://github.com/ubclaunchpad/scoop-bucket
+	scoop install inertia
+
+Users of other platforms can install the Inertia CLI from the Releases page,
+found here: https://github.com/ubclaunchpad/inertia/releases/latest
+
+To help with usage, most relevant documentation can be seen by using the --help
+flag on any command:
+
+	inertia --help
+	inertia init --help
+	inertia [REMOTE] up --help
+
+Documentation can also be triggered by simply entering a command without the
+prerequisite arguments or additional commands:
+
+	inertia remote               # documentation about remote configuration
+
+Inertia has two "core" sets of commands - one that primarily handles local
+configuration, and one that allows you to control your remote VPS instances and
+their associated deployments.
+
+For local configuration, most commands will build off of the root "inertia ..."
+command. For example, a typical set of commands to set up a project might look
+like:
+
+	inertia init                 # initiates Inertia configuration
+	inertia remote add my_cloud  # adds configuration for a remote VPS instance
+
+The other set of commands are based on a remote VPS configuration, and the
+available commands can be seen by running:
+
+	inertia [REMOTE] --help
+
+In the previous example, the next steps to set up a deployment might be:
+
+	inertia my_cloud init        # bootstraps remote and installs Inertia daemon
+	inertia my_cloud up          # deploys your project
+
+Some of these commands offer a --stream flag that allows you to view realtime
+log feedback from the daemon.
+
+More documentation on Inertia, how it works, and how to use it can be found
+in the project repository: https://github.com/ubclaunchpad/inertia/tree/master
+
+*/
+package main