From 0f7667ab4944e48214a823411ed52227bc6dbafe Mon Sep 17 00:00:00 2001 From: Ben McCann <322311+benmccann@users.noreply.github.com> Date: Tue, 30 May 2023 13:57:39 -0700 Subject: [PATCH] docs: update migration tool README (#10066) --- .changeset/chilled-suns-battle.md | 5 +++++ packages/migrate/README.md | 10 ++++------ 2 files changed, 9 insertions(+), 6 deletions(-) create mode 100644 .changeset/chilled-suns-battle.md diff --git a/.changeset/chilled-suns-battle.md b/.changeset/chilled-suns-battle.md new file mode 100644 index 000000000000..05c67e46e250 --- /dev/null +++ b/.changeset/chilled-suns-battle.md @@ -0,0 +1,5 @@ +--- +'svelte-migrate': patch +--- + +docs: update readme diff --git a/packages/migrate/README.md b/packages/migrate/README.md index cc57be4d5e74..89a5f1730f15 100644 --- a/packages/migrate/README.md +++ b/packages/migrate/README.md @@ -8,10 +8,8 @@ npx svelte-migrate [migration] ## Migrations -Right now, there's only one migration — `routes`: +The available migrations are: -``` -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`. +- `routes` - This will update your pre-SvelteKit-1.0 codebase to the SvelteKit 1.0 routes format. 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`. Read [the discussion](https://github.com/sveltejs/kit/discussions/5748) for full details. +- `package` - Migration to @sveltejs/package v2. Review the migration guide at [#8922](https://github.com/sveltejs/kit/pull/) and read the updated docs at https://kit.svelte.dev/docs/packaging +- `svelte-4` - This will migrate your codebase from Svelte 3 to Svelte 4