WIP: initial commit

README.md

@@ -1,3 +1,22 @@
 # sqlgen
 
-SQL crud generator for Go.
+## Installing
+
+```
+go install git.crumpington.com/lib/go/sqlgen/cmd/sqlgen@latest
+```
+
+## Usage
+
+```
+sqlgen [driver] [defs-path] [output-path]
+```
+
+## File Format
+
+```
+TABLE [sql-name] OF [go-type] <NoInsert> <NoUpdate> <NoDelete> (
+    [sql-column] [go-type] <AS go-name> <PK> <NoInsert> <NoUpdate>,
+    ...
+);
+```