diff --git a/README.md b/README.md index 0dc7cf2..a17bb9c 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,14 @@ additionally, the lack of configuration compelled me even more to write my own s `shards install` && `shards build` -## setup +## configuration copy `.env.example` to `.env` and fill it out, same for `config.example.toml` -> `config.toml` +by default, the config emulates vanilla GD servers as closely as possible, but you'll likely want to change it - most options have comments detailing what exactly they do + +## setup + run `bin/crystal-gauntlet migrate` (or `shards run -- migrate`) **schemas are highly unstable so you will be offered 0 support in migrating databases for now**, however in the future you'll want to run this each time you update