From 2b71f8c7cdbcda3b3e05502b582d1acc344d92b8 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 30 Dec 2023 17:32:09 -0500 Subject: Tweak readme description --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d311467..742af56 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Bolt -Bolt is a command-line tool written that allows you to write and manage plain SQL upgrade and downgrade migrations. +Bolt is a command-line tool that helps you manage your database migrations. It allows you to write +your database migrations in plain SQL, and Bolt will handle ensuring they are applied and executed +in the correct order. ## Installation @@ -14,3 +16,7 @@ $ GOBIN=/usr/local/bin/ go install ./cmd/bolt/bolt.go This will install a `bolt` binary under `/usr/local/bin/` that you may then use by running `bolt` from a command-line. + +## Database Compatibility + +At the moment, only PostgreSQL is supported. You're welcome to contribute support for other databases. -- cgit v1.2.3