diff --git a/README.md b/README.md index e36b14e..558ac5f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ A auth web API services for the Icarus project. # Getting Started +Install the `sqlx` tool to use migrations. +``` +cargo install sqlx-cli +``` +This will be used to scaffold development for local environments. + + The easiest way to get started is through docker. This assumes that docker is already installed on your system. Copy the `.env.docker.sample` as `.env`. Most of the data in the env file doesn't need to be modified. The `SECRET_KEY` variable should be changed since it will be used for token