marc/cobble
1
0
Fork 0
Code Issues Releases Activity Actions

docs: add install/config tips
Some checks failed
/ build (push) Blocked by required conditions
Details
/ tests (push) Successful in 43s
Details
/ sast (push) Has been cancelled
Details

Browse source
This commit is contained in:
Marc 2024-07-11 21:32:25 -04:00
parent 44f41823d3
commit 5dc776b0d2
Signed by: marc
GPG key ID: 048E042F22B5DC79
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,3 +1,23 @@
# cobble # cobble
👞 A simple SQL migration utility 👞 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
```