Fix templating in README

[candle] / README.md

diff --git a/README.md b/README.md
index 0a43cf89dd4075acad4bd8bebf6215ad3a8905a1..de62c709f3967ccb8b31e3e0772285cd79a0fc5b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,41 @@
-= Candle =
+# Candle

 
 Continuous Integration for SBCL based Lisp projects, using AWS instances
 as the machines on which the CI's are run.
 
 
 Continuous Integration for SBCL based Lisp projects, using AWS instances
 as the machines on which the CI's are run.
 

-= .candle file =
+# .candle file

 
 Each project with a candle file has a .candle file in the root of the project
 with tasks to be run.
 
 
 Each project with a candle file has a .candle file in the root of the project
 with tasks to be run.
 

-= Usage =
+# Limitations

 
 

-Run bin/candle
+This documentation needs to be updated once more things are working, but this is an
+early version of everything.
+
+This only works in the following:
+
+ * SBCL
+ * Linux
+ * Git as source control
+ * AWS as remote code
+
+There is also no email, and everything else handled via the CLI.
+
+Only one can be running at a time.
+
+# Usage
+
+* Run bin/candle-server on a server somewhere, so that the candle client can connect to it
+* Add projects via `bin/candle project add`, see `--help` for more information
+* Remove projects via `bin/candle project delete`, see `--help` for more information
+* Run `bin/candle project show <name>` to show status of project
+  * Includes what branches are failing
+* Run `bin/candle project list` to show list all projects, and status
+* Run `bin/candle project refresh` to refresh a project
+* Run `bin/candle job log <project>:<sha>` to see log
+* Run `bin/candle job retry <project>:<sha>` to retry the job
+
+## Local
+
+* Run `bin/candle run` from a candle enabled project