diff --git a/.changeset/loud-parrots-sell.md b/.changeset/loud-parrots-sell.md new file mode 100644 index 000000000000..05f713cc5451 --- /dev/null +++ b/.changeset/loud-parrots-sell.md @@ -0,0 +1,5 @@ +--- +'svelte-migrate': patch +--- + +Add a README' diff --git a/packages/migrate/README.md b/packages/migrate/README.md new file mode 100644 index 000000000000..cc57be4d5e74 --- /dev/null +++ b/packages/migrate/README.md @@ -0,0 +1,17 @@ +# svelte-migrate + +A CLI for migrating Svelte(Kit) codebases. + +``` +npx svelte-migrate [migration] +``` + +## Migrations + +Right now, there's only one migration — `routes`: + +``` +npx svelte-migrate routes +``` + +This will update your codebase in readiness for https://github.com/sveltejs/kit/discussions/5748. The script will automate as much of the conversion as possible, then annotate your codebase with tasks for completion that you can find by searching for `@migration`.