From ca32dbe0f45ca52a120c222f98bee33b43952050 Mon Sep 17 00:00:00 2001
From: Marc Coquand <marc@mccd.space>
Date: Mon, 25 Dec 2023 19:08:10 -0600
Subject: Update readme

---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index cc1a4ff..024395b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,34 @@
-# Fixgen - 0 dependency language independent fixture generator
+# (WIP) Fixgen - Language agnostic fixture generator
+
+- Zero dependencies
+- Language agnostic
 
 This tool allows you to very easily generate fixtures.
 
+You simply define a fixgen file, for example sample.fixgen
+
+```
+user (2): id uuidv4, name name
+purchase (10): id uuidv4, buyer user.id, amount int<1,40>
+```
+
+And then run it
+
+```
+$ fixgen sample.fixgen -f csv -o fixtures
+```
+
+And it generates two files: fixtures/purchase.csv, fixtures/user.csv. Bam! Simple as that.
+
+You can then import it into your SQL server with simple copy from commands
+
+```
+COPY users FROM '/fixtures/user.csv' CSV HEADER;
+COPY purchases FROM '/fixtures/purchase.csv' CSV HEADER;
+```
+
+Or maybe export as json instead to import into your NoSQL DB.
+
 ## Development - Prerequisites
 
 - [Nix](https://nixos.org/manual/nix/stable/installation/installing-binary)
@@ -13,7 +40,7 @@ After installation, you will need to run direnv allow
 direnv allow
 ```
 
-For it to work.
+And it will set up the development environment for you with the correct git hooks.
 
 ### VSCode
 
-- 
cgit v1.2.3