chore: add some basic README files

.changeset/dry-melons-punch.md

@@ -0,0 +1,8 @@
+---
+'@emigrate/plugin-generate-js': patch
+'@emigrate/plugin-tools': patch
+'emigrate': patch
+'@emigrate/tsconfig': patch
+---
+
+Add some simple README's for each package and add homepage, repository and bugs URLs to each package.json file

package.json

@@ -31,6 +31,9 @@
       "email": "joakim@aboviq.com"
     }
   ],
+  "homepage": "https://github.com/aboviq/emigrate",
+  "repository": "https://github.com/aboviq/emigrate",
+  "bugs": "https://github.com/aboviq/emigrate/issues",
   "license": "MIT",
   "volta": {
     "node": "20.9.0",

packages/emigrate/README.md

@@ -0,0 +1,21 @@
+# emigrate
+
+Emigrate is a tool for managing database migrations. It is designed to be simple yet support advanced setups, modular and extensible.
+
+## Installation
+
+Install Emigrate in your project:
+
+```bash
+npm install --save-dev emigrate
+```
+
+## Usage
+
+Create a new migration:
+
+```bash
+emigrate new -d migrations -e .js create some fancy table
+```
+
+Will create a new empty JavaScript migration file with the name "YYYYMMDDHHmmssuuu_create_some_fancy_table.js" in the `migrations` directory.

packages/emigrate/package.json

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

packages/plugin-generate-js/README.md

@@ -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],
+};
+```

packages/plugin-generate-js/package.json

@@ -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:*"

packages/plugin-tools/README.md

@@ -0,0 +1,3 @@
+# @emigrate/plugin-tools
+
+This package contains utilities and types to simplify creating and working with Emigrate plugins.

packages/plugin-tools/package.json

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

packages/tsconfig/README.md

@@ -0,0 +1,3 @@
+# @emigrate/tsconfig
+
+This package contains the default TypeScript configuration for Emigrate packages.

packages/tsconfig/package.json

@@ -9,6 +9,9 @@
     "build.json"
   ],
   "author": "Aboviq AB <dev@aboviq.com> (https://www.aboviq.com)",
+  "homepage": "https://github.com/aboviq/emigrate/tree/main/packages/tsconfig#readme",
+  "repository": "https://github.com/aboviq/emigrate/tree/main/packages/tsconfig",
+  "bugs": "https://github.com/aboviq/emigrate/issues",
   "license": "MIT",
   "volta": {
     "extends": "../../package.json"