add readme to svelte-migrate (#5817)

sveltejs · Aug 4, 2022 · b901efe · b901efe
1 parent 743f1c0
commit b901efe
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/.changeset/loud-parrots-sell.md 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
@@ -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`.