From e5658d1f61415054029b66cd2f703f1f40138460 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 18 Oct 2025 10:43:39 -0400 Subject: Add support for migration dependencies --- docs/index.md | 44 ++++++++++++++++++-------------------------- 1 file changed, 18 insertions(+), 26 deletions(-) (limited to 'docs/index.md') diff --git a/docs/index.md b/docs/index.md index 91b8891..b524074 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,37 +5,32 @@ [![GoDoc](https://godoc.org/git.sr.ht/~eugenetriguba/bolt?status.svg)](https://godoc.org/git.sr.ht/~eugenetriguba/bolt) [![Go Report Card](https://goreportcard.com/badge/git.sr.ht/~eugenetriguba/bolt)](https://goreportcard.com/report/git.sr.ht/~eugenetriguba/bolt) -Bolt is a command-line tool designed to simplify and streamline your database migration process. +Bolt is a command-line tool designed to simplify and streamline your database +migration process. -It is distributed as a standalone binary, making it easy to run anywhere without having to setup any tooling, and it is language independent. It doesn't matter what programming language you're using, you can use Bolt for any project you have. +It is distributed as a standalone binary, making it easy to run anywhere +without having to setup any tooling, and it is language independent. It +doesn't matter what programming language you're using, you can use Bolt +for any project you have. ## Features -- **Plain SQL migrations** - Schema migrations are written in plain SQL -- **Flexible versioning** - Migrations can be versioned sequentially or by creation timestamp -- **Transactional by default** - All migrations run in transactions by default -- **Bidirectional migrations** - Supports up and down migrations and jumping to any particular schema version -- **Multi-database support** - Supports PostgreSQL, MySQL, SQL Server, and SQLite3 +- Schema migrations are written in plain SQL +- Migrations can be versioned sequentially or by creation timestamp +- All migrations run in transactions by default +- Supports up and down migrations and jumping to any particular schema version +- Supports PostgreSQL, MySQL, SQL Server, and SQLite3 ## Quick Start ### Install Bolt -#### Go install - ```bash go install git.sr.ht/~eugenetriguba/bolt/cmd/bolt@v0.11.0 ``` This will install Bolt to your `$GOBIN` directory. Make sure that `$GOBIN` is in your `$PATH`. -#### Homebrew - -```bash -brew tap eugenetriguba/bolt https://git.sr.ht/~eugenetriguba/homebrew-bolt -brew install bolt -``` - ### Create your first migration ```bash @@ -78,13 +73,10 @@ bolt up ## Next Steps -- Follow the complete [Tutorial](tutorial.md) for a detailed walkthrough -- Check out [How-To Guides](how-to.md) for specific tasks -- Browse the [Reference](reference.md) for commands and configuration options -- Read [Explanations](explanation.md) to understand how Bolt works internally - -## Getting Help - -- Read the [documentation](https://bolt.eugenetriguba.com) -- Check the [issue tracker](https://todo.sr.ht/~eugenetriguba/bolt) -- View the [source code](https://git.sr.ht/~eugenetriguba/bolt) +- Read the [installation guide](./installation.md) for all installation options. +- Follow the [Tutorial](tutorial.md) for a detailed walkthrough. +- Check out [How-To Guides](how-to.md) for specific tasks. +- Browse the [Reference](reference.md) for commands and configuration options. +- Read [Explanations](explanation.md) to understand how Bolt works internally. +- See [Contributing](contributing.md) if you're interesting in contributing to + Bolt. -- cgit v1.2.3