From a1a2c68b7579d4d0e44def67071fa1db8ededd61 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 30 Dec 2023 17:06:08 -0500 Subject: Add basic README on installation instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5a734b4..d311467 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ # Bolt + +Bolt is a command-line tool written that allows you to write and manage plain SQL upgrade and downgrade migrations. + +## Installation + +You may download the binary from the Releases page or install it from source using Go: + +```bash +$ git clone github.com/eugenetriguba/bolt +$ cd bolt +$ 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. -- cgit v1.2.3