update README
This commit is contained in:
12
README.md
12
README.md
@@ -2,6 +2,12 @@
|
|||||||
|
|
||||||
This plugin enables code-based database migrations in Ktor using [Kotlin Database Migration](https://git.infendro.com/Infendro/kotlin-migration).
|
This plugin enables code-based database migrations in Ktor using [Kotlin Database Migration](https://git.infendro.com/Infendro/kotlin-migration).
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
* Declare database migrations (identified by a unique name).
|
||||||
|
* Migrations are executed in the order they are declared in.
|
||||||
|
* Executed migrations are tracked in a database table and skipped on subsequent runs.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Add the following to your `build.gradle.kts`.
|
Add the following to your `build.gradle.kts`.
|
||||||
@@ -36,9 +42,3 @@ fun Application.configureDatabase() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## How It Works
|
|
||||||
|
|
||||||
* Each migration is identified by a unique name.
|
|
||||||
* Migrations are executed in the order they are declared in.
|
|
||||||
* Executed migrations are tracked in a database table and skipped on subsequent runs.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user