aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1a4d34a..ec3d3b8 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,19 @@ A very simple migration library for your Go projects.
## Features
-- Any database/sql drivers should work. See https://github.com/golang/go/wiki/SQLDrivers
+- Any database/sql compatible drivers should work. See
+ https://github.com/golang/go/wiki/SQLDrivers
- Each migration is run in a transaction so there should be no 'dirty' state.
- Only migrates "up". I have never used a "down" migration.
-- Enables a callback function to suit whatever logging implementation you choose.
+- Enables a callback function to suit whatever logging implementation you
+ choose.
-## Usage
+- Supports Go1.16's io/fs interface for embedded migrations.
+
+## Example usage
```go
import "src.userspace.com.au/go-migrate"