X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=sheep;a=blobdiff_plain;f=README.md;h=3d1ce91485879a947d8630bfbd384a46523117b5;hp=3d8714a02b839d29ea44e9f1a01de76502703095;hb=d898031;hpb=1ba7b003f48765c807cabfb3659e208f77d561fc

diff --git a/README.md b/README.md
index 3d8714a..3d1ce91 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ Enforcement of documentation guidelines for my Common Lisp Projects, as well as
 
 I wish I had aspirations for this being some standard that someone else might follow, but realistically I'm just irritated at my own laziness with regard to documentation, so I wrote a solution.  The forceful nature of the validator is really just because I didn't want to write a smarter parser.  As an added bonus, all the docs now look the same when I look at them in the repl, so that's kind of nice.
 
+If you like, you can [download it](https://github.com/frankduncan/docgen/releases/download/0.3/docgen_0.3.tar.gz)
+
 ## Usage
 
 See the [wiki](https://github.com/frankduncan/docgen/wiki) for usage information (generated by this package).
@@ -16,7 +18,36 @@ Packages are documented by sections broken up by one empty line, with the first
 
 ## Structure/Condition documentation
 
-Requirements are the same as the package
+Requirements are the same as the package documentation.
+
+## Variable documentation
+
+Variables should follow the template:
+
+```
+*VARIABLE*
+
+VALUE TYPE:
+
+  a generalized boolean
+
+INITIAL VALUE:
+
+  NIL
+
+DESCRIPTION:
+
+  *VARIABLE* is expected to be a boolean, but
+  most anything can be it.
+
+EXAMPLES:
+
+  (let ((*variable* t)) (go)) => let-it-go
+````
+
+There are three required sections and one optional section.  ```VALUE TYPE```, ```INITIAL VALUE```, and ```DESCRIPTION``` are freeform, with the ```EXAMPLES``` section following the same rules as below in the function documentation.
+
+### 
 
 ## Function documentation