Fix templating in README

[candle] / README.md

diff --git a/README.md b/README.md
index cb78e454e615d5e476e0624f5d16998d9f8fb3d1..de62c709f3967ccb8b31e3e0772285cd79a0fc5b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-= Candle =
+# Candle
 
 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.
 
-= Limitations =
+# Limitations
 
 This documentation needs to be updated once more things are working, but this is an
 early version of everything.
@@ -24,33 +24,18 @@ There is also no email, and everything else handled via the CLI.
 
 Only one can be running at a time.
 
-= Usage =
+# 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
+* 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 job --log <project>:<sha>` to see log
+* 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 ==
+## Local
 
 * Run `bin/candle run` from a candle enabled project
-
-= General Design =
-
-For all projects added, a watcher thread runs `git fetch origin` to see if there's any
-new SHAs for which jobs need to be run.
-
-When a previously unknown SHA shows up in the git directory, a job is created for that
-SHA, which then clones the repository into the right place and runs `candle` for that location,
-if there's a .candle file.
-
-A project is failing if any branches are failing, that is to say that the current sha
-for that branch is failing.
-
-== Edge Cases ==
-
-* For SHAs that hang, or get into infinite loops, there's a timeout before the server is killed
-  and marked as failure.