aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2023-12-30 17:06:08 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2023-12-30 17:06:08 -0500
commita1a2c68b7579d4d0e44def67071fa1db8ededd61 (patch)
tree49a8f14a2cc9481b0a6b45f453d754defac4a2f7 /README.md
parentAdd initial code (diff)
downloadcli-a1a2c68b7579d4d0e44def67071fa1db8ededd61.zip
Add basic README on installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
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.