From a995110a77fa5a500e7d760f34d154671265c821 Mon Sep 17 00:00:00 2001 From: Tom Meagher Date: Wed, 25 Oct 2023 19:08:05 -0400 Subject: [PATCH] chore: changeset --- .changeset/hungry-crabs-brake.md | 5 +++++ README.md | 16 ++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .changeset/hungry-crabs-brake.md diff --git a/.changeset/hungry-crabs-brake.md b/.changeset/hungry-crabs-brake.md new file mode 100644 index 0000000..06a5012 --- /dev/null +++ b/.changeset/hungry-crabs-brake.md @@ -0,0 +1,5 @@ +--- +"kysely-migrate": patch +--- + +Added codegen diff --git a/README.md b/README.md index b4fe79b..4e7f2bb 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,10 @@ Run `kysely-migrate --help` or `kysely-migrate --help` to see the list Creates [`Config`](#config) object. +```ts +import { defineConfig } from 'kysely-migrate' +``` + | Name | Type | Description | | ------- | ------------------------------------------ | --------------------------------------------------------------------- | | `config` | `Config \| (() => Config \| Promise)` | Configuration object or a function that returns a configuration object. | @@ -63,6 +67,10 @@ Creates [`Config`](#config) object. Loads environment variables from `.env` or `.env.*` files. +```ts +import { loadEnv } from 'kysely-migrate' +``` + | Name | Type | Description | | -------------- | ------------------------- | ------------------------------------------- | | `config.mode` | `string \| undefined` | `.env` file type (e.g. `` `.env.${mode}` ``) | @@ -73,6 +81,10 @@ Loads environment variables from `.env` or `.env.*` files. `Config` object. +```ts +import { type Config } from 'kysely-migrate' +``` + ```ts { /** Kysely instance used to manipulate migrations and introspect database */ @@ -113,6 +125,10 @@ import { } from 'kysely-migrate' ``` +## Contributing + +Contributions to kysely-migrate are greatly appreciated! If you're interested in contributing, please create a [new GitHub Discussion](https://github.com/tmm/kysely-migrate/discussions/new?category=ideas) with some info on what you would like to work on **before submitting a pull request**. + ## Sponsors If you find kysely-migrate useful or use it for work, please consider supporting development on [GitHub Sponsors](https://github.com/sponsors/tmm). Thank you 🙏