From: Mike D. Lowis <mike@mdlowis.com>
Date: Sun, 4 Mar 2012 17:06:42 +0000 (-0500)
Subject: Updated readme
X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=c0973d27437430d98c2c7f961cfcb6689e790b83;p=archive%2Fbci.git

Updated readme
---

diff --git a/README b/README
deleted file mode 100644
index f1d860e..0000000
--- a/README
+++ /dev/null
@@ -1,2 +0,0 @@
-Distributed Continuous Integration written in bash.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1e811ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+BCI
+==============================================
+
+About This Project
+----------------------------------------------
+
+A distributed continuous integration script written in bash script.
+
+Installation
+----------------------------------------------
+
+BCI can be installed on any machine that has Bash and basic unix utilities by
+executing the following commands:
+
+    $ BCI_HOME="$HOME/.bci"
+    $ mkdir -p "$BCI_HOME"
+
+BCI scripts will install to $BCI_HOME/bin which should then be added toyour
+$PATH variable
+
+Using BCI
+----------------------------------------------
+
+### Adding a Project
+
+The following command will add a project to the BCI projects directory.
+
+    $ bci add some_project git@github.com:some_user/some_project.git
+
+### Deleting a Project
+
+The following command will delete a project from the BCI projects directory.
+
+    $ bci del some_project
+
+### Listing Projects
+
+The following command will list all projects in the BCI projects directory.
+
+    $ bci ls
+
+### Forcing an Update
+
+The following command will force a git pull on the selected BCI project.
+
+    $ bci update some_project
+
+### Forcing a Build
+
+The following command will force an execution of teh configured build command
+for the given project
+
+    $ bci build some_project
+