aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2026-02-12 19:14:17 -0500
committerEugene Triguba <hello@eugenetriguba.com>2026-02-12 19:14:17 -0500
commit449f74ded67b49fb3066d6d107fa6de9dba0093c (patch)
treed18017e8e318541781d5cf1cb3e161d3c2ee0be8 /docs/index.md
parentRelease v0.12.1 (diff)
downloadcli-449f74ded67b49fb3066d6d107fa6de9dba0093c.zip
Replace HTML docs with man pages that ship with bolt
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md82
1 files changed, 0 insertions, 82 deletions
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index e024c08..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,82 +0,0 @@
-# Bolt
-
-![Version](https://img.shields.io/badge/version-0.12.1-blue)
-[![Build Status](https://builds.sr.ht/~eugenetriguba/bolt/commits/main.svg)](https://builds.sr.ht/~eugenetriguba/bolt/commits/main?)
-[![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.
-
-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
-
-- 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
-
-```bash
-go install git.sr.ht/~eugenetriguba/bolt/cmd/bolt@v0.12.1
-```
-
-This will install Bolt to your `$GOBIN` directory. Make sure that `$GOBIN` is in your `$PATH`.
-
-### Create your first migration
-
-```bash
-bolt new -m "create users table"
-```
-
-### Write your migration
-
-Edit the generated SQL file in the `migrations/` directory:
-
-```sql
--- migrate:up
-CREATE TABLE users (
- id SERIAL PRIMARY KEY,
- name VARCHAR(255) NOT NULL,
- email VARCHAR(255) NOT NULL,
- created_at TIMESTAMP NOT NULL DEFAULT NOW(),
- updated_at TIMESTAMP NOT NULL DEFAULT NOW()
-);
-
--- migrate:down
-DROP TABLE users;
-```
-
-### Configure Bolt
-
-Create a `bolt.toml` file:
-
-```toml
-[database]
-dsn = "postgresql://user:password@localhost:5432/mydb?sslmode=disable"
-driver = "postgresql"
-```
-
-### Apply your migration
-
-```bash
-bolt up
-```
-
-## Next Steps
-
-- 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.