chore: more readme, fix init commands

inoutgg · Oct 9, 2024 · 2bf424a · 2bf424a
1 parent 30d5971
commit 2bf424a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,22 @@
 
 An SQL migrator that is easy to embed.
 
+## Getting started
+
+### Creating a new Conduit migration project
+
+To create a new conduit project run in the current directory:
+
+```
+$ conduit init
+```
+
+By default conduit initialises a new project in `$(cwd)/migrations` to create the project in a different location.
+
+```
+$ conduit init --migrations-dir path/to/project
+```
+
 ## FAQ
 
 <details>

diff --git a/internal/command/common/common.go b/internal/command/common/common.go
@@ -9,7 +9,7 @@ import (
 
 var (
 	databaseUrlFlagName   = "database-url"
-	migrationsDirFlagName = "dir"
+	migrationsDirFlagName = "migrations-dir"
 )
 
 var DatabaseURLFlag = &cli.StringFlag{

diff --git a/internal/command/initialise/initialise.go b/internal/command/initialise/initialise.go
@@ -18,6 +18,7 @@ func NewCommand() *cli.Command {
 		Aliases: []string{"i"},
 		Usage:   "initialise migration directory",
 		Flags: []cli.Flag{
+			common.MigrationsDirFlag,
 			&cli.StringFlag{
 				Name:    "namespace",
 				Aliases: []string{"ns"},