docs: add install/config tips
This commit is contained in:
parent
44f41823d3
commit
5dc776b0d2
1 changed files with 21 additions and 1 deletions
20
README.md
20
README.md
|
@ -1,3 +1,23 @@
|
|||
# cobble
|
||||
|
||||
👞 A simple SQL migration utility
|
||||
|
||||
## Installing
|
||||
|
||||
Through `go`, the tool can be installed via:
|
||||
|
||||
```bash
|
||||
go install forge.karnov.club/marc/cobble
|
||||
```
|
||||
|
||||
## Configuring
|
||||
|
||||
Connection details about the database to apply migrations on can be provided via environment variables:
|
||||
|
||||
```bash
|
||||
DB_HOST=... # Database host
|
||||
DB_PORT=... # Database port
|
||||
DB_APP_USER=... # Username to connect with when applying migrations
|
||||
DB_APP_PASSWORD=... # Password to use to connect as $DB_APP_USER
|
||||
DB_NAME=... # Database name to apply migrations on
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue