aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 742af56..9d168a0 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
# Bolt
-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.
+> :warning: **This project is in early development. I wouldn't recommend using it.**
+
+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
-You may download the binary from the Releases page or install it from source using Go:
+You may install Bolt from source using the following commands:
```bash
$ git clone github.com/eugenetriguba/bolt
@@ -14,8 +16,8 @@ $ 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.
+This will install a `bolt` binary under `/usr/local/bin/` that you may
+then use by running `bolt` from a command-line.
## Database Compatibility