diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2023-12-30 23:42:21 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2023-12-30 23:42:21 -0500 |
| commit | 90909e262949841f9aa1f8b1f11fa4e49ae5d9db (patch) | |
| tree | fdaa09b751c8af2a64c6ab22cbd3a358e305b31e /README.md | |
| parent | Release v0.1.0 (diff) | |
| download | cli-90909e262949841f9aa1f8b1f11fa4e49ae5d9db.zip | |
Add disclaimer
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -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 |