chore: add some basic README files

This commit is contained in:
Joakim Carlstein 2023-11-15 10:32:47 +01:00
parent 9484c03e48
commit 50fce0a5ed
10 changed files with 78 additions and 0 deletions

View file

@ -0,0 +1,28 @@
# @emigrate/plugin-generate-js
This package contains an Emigrate plugin for generating migration files using JavaScript as a language.
## Usage
Install the package:
```bash
npm install --save-dev @emigrate/plugin-generate-js
```
Use the plugin with the `emigrate new` command:
```bash
emigrate new --plugin generate-js create some fancy table
```
Or add it to your `emigrate.config.js` file:
```js
import generateJs from '@emigrate/plugin-generate-js';
export default {
directory: 'migrations',
plugins: [generateJs],
};
```

View file

@ -26,6 +26,9 @@
"generate"
],
"author": "Aboviq AB <dev@aboviq.com> (https://www.aboviq.com)",
"homepage": "https://github.com/aboviq/emigrate/tree/main/packages/plugin-generate-js#readme",
"repository": "https://github.com/aboviq/emigrate/tree/main/packages/plugin-generate-js",
"bugs": "https://github.com/aboviq/emigrate/issues",
"license": "MIT",
"dependencies": {
"@emigrate/plugin-tools": "workspace:*"