describe migration package

c9s · Jan 19, 2024 · 8f7715a · 8f7715a
1 parent 8ff3b46
commit 8f7715a
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -160,6 +160,15 @@ Apply all available migrations:
 rockhopper up
 ```
 
+When marking the migration script with `@package app1`, the migration scripts will be executed per package,
+here is the flow:
+
+- Collect all migration scripts
+- Categorize the migration scripts by their package name
+- Iterate the migration scripts by package
+
+The default package name is set to `main`
+
 ## Downgrade
 
 Roll back a single migration from the current version: