readme

sr · Oct 18, 2008 · e2cd6a3 · e2cd6a3
1 parent 3310c9e
commit e2cd6a3
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.markdown b/README.markdown
@@ -0,0 +1,20 @@
+Statig
+======
+
+Statig is a [thor](http://github.com/wycats/thor) task to manage a static website
+tracked with git. Don't expect anything fancy.
+
+Install
+-------
+
+    cd ~/web/example.org
+    thor install http://github.com/sr/statig/statig.rb?raw=true
+    wget http://github.com/sr/statig/statig.sample.yml.rb?raw=true
+    cp statig.sample.yml config.yml
+    echo "thor statig:build ../.." >> .git/hooks/post-commit
+
+Usage
+-----
+
+    $EDITOR somepage.textile
+    git commit -a -m "some commit message"