aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Coquand <marc@mccd.space>2023-12-25 19:08:10 -0600
committerMarc Coquand <marc@mccd.space>2023-12-26 09:57:11 -0600
commitca32dbe0f45ca52a120c222f98bee33b43952050 (patch)
tree0543ae71769bc8aa8aec429570600a378e589787
parent262f161f42c4e59beec41c6f440336c38385426a (diff)
downloadfixgen-ca32dbe0f45ca52a120c222f98bee33b43952050.tar.gz
fixgen-ca32dbe0f45ca52a120c222f98bee33b43952050.tar.bz2
fixgen-ca32dbe0f45ca52a120c222f98bee33b43952050.zip
Update readme
-rw-r--r--README.md31
1 files 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