update README
This commit is contained in:
12
README.md
12
README.md
@@ -2,6 +2,12 @@
|
||||
|
||||
This library enables code-based database migrations in Kotlin.
|
||||
|
||||
## 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
|
||||
|
||||
Add the following to your `build.gradle.kts`.
|
||||
@@ -35,9 +41,3 @@ fun 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