Merge branch 'patch-1' of https://github.com/westy92/plugin-typescript

wzrdtales · wzrdtales · commit 4de75cfed6fe · 2017-10-05T15:46:21.000+02:00
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # Plugin-Typescript
 A TypeScript plugin for db-migrate.
 
+## Usage
+
 Usage is very simple. Simply install this plugin via `npm install db-migrate-plugin-typescript`
 or if using yarn: `yarn add db-migrate-plugin-typescript` 
 
@@ -9,3 +11,7 @@ using your regular `tsconfig.json`
 
 Do however note that this has no effect on generating new migrations.
 Using `db-migrate create FooMigrations.ts` will not create a TypeScript migration file.
+
+## Immplementation Detail
+
+The plugin hooks into the functionality of `db-migrate` itself. In this case it hooks into `migrator:migration:hook:require`, which in this case requires another transpiler (TypeScript) and registers also a new file extension (.ts). Make sure to name your migrations accordingly (ending with .ts).
