diff --git a/README.md b/README.md index 096f72a..22b9f75 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ -# migration-helper +# Migration 🧳 Helper -> A tiny helper library for migrating data. +> **Tiny helper library for migrating data.** -* Zero dependencies -* 100% code coverage -* TypeScript definitions included +## Features + +* Zero dependencies. +* 100% code coverage. +* TypeScript definitions included. + +## Registry Setup + +To use this package, add a registry for the `@holllo` scope to your npm configuration. + +``` +npm config set @holllo:registry https://git.bauke.xyz/api/packages/Holllo/npm/ +``` ## Usage -```sh -npm install migration-helper -``` - ```ts -import {migrate, Migration} from 'migration-helper'; +import {migrate, Migration} from '@holllo/migration-helper'; // Your data that needs migrating. const data = 'data'; @@ -40,6 +46,8 @@ const migrated = await migrate(data, version, migrations); console.log(migrated); ``` -See [the tests directory] for how to use `number`, `Date` or a custom way of versioning. +See [the tests directory](https://git.bauke.xyz/Holllo/migration-helper/src/branch/main/tests) for how to use `number`, `Date` or a custom way of versioning. -[the tests directory]: tests/ +## License + +Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Holllo/migration-helper/src/branch/main/LICENSE) for more information.