Skip to content

Commit c11b051

Browse files
docs: add cli documentation link (#332)
* docs: add cli documentation link * docs: add sv-migrate doc links * Update README.md * Update README.md --------- Co-authored-by: Ben McCann <[email protected]>
1 parent c82cec3 commit c11b051

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Read the [SvelteKit documentation](https://svelte.dev/docs/kit) for more details
66

77
### Packages
88

9-
| Package | Changelog |
10-
| ---------------------------------- | ------------------------------------------ |
11-
| [sv](packages/cli) | [Changelog](packages/cli/CHANGELOG.md) |
12-
| [svelte-migrate](packages/migrate) | [Changelog](packages/migrate/CHANGELOG.md) |
9+
| Package | Changelog | Documentation |
10+
| ---------------------------------- | ------------------------------------------ | ------------------------------------------------------- |
11+
| [sv](packages/cli) | [Changelog](packages/cli/CHANGELOG.md) | [Documentation](https://svelte.dev/docs/cli/overview) |
12+
| [svelte-migrate](packages/migrate) | [Changelog](packages/migrate/CHANGELOG.md) | [Documentation](https://svelte.dev/docs/cli/sv-migrate) |
1313

1414
## Contributing
1515

packages/cli/README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@ A command line interface (CLI) for creating and maintaining [Svelte](https://sve
66
npx sv
77
```
88

9-
## Acknowledgements
9+
## Documentation
1010

11-
Thank you to [Christopher Brown](https://github.com/chbrown) who originally owned the `sv` name on npm for graciously allowing it to be used for this package. You can find the original `sv` package at [`@chbrown/sv`](https://www.npmjs.com/package/@chbrown/sv).
12-
13-
This project was formed by merging the `create-svelte` and `svelte-add` CLIs. Thank you to [J](https://github.com/babichjacob) for starting the community-led `svelte-add` project and to the [`svelte-add` contributors](https://github.com/svelte-add/svelte-add/graphs/contributors).
11+
[Documentation](https://svelte.dev/docs/cli/overview)
1412

1513
## Changelog
1614

@@ -19,3 +17,9 @@ This project was formed by merging the `create-svelte` and `svelte-add` CLIs. Th
1917
## License
2018

2119
[MIT](../../LICENSE)
20+
21+
## Acknowledgements
22+
23+
Thank you to [Christopher Brown](https://github.com/chbrown) who originally owned the `sv` name on npm for graciously allowing it to be used for this package. You can find the original `sv` package at [`@chbrown/sv`](https://www.npmjs.com/package/@chbrown/sv).
24+
25+
This project was formed by merging the `create-svelte` and `svelte-add` CLIs. Thank you to [J](https://github.com/babichjacob) for starting the community-led `svelte-add` project and to the [`svelte-add` contributors](https://github.com/svelte-add/svelte-add/graphs/contributors).

packages/migrate/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ npx sv migrate [migration]
2626

2727
Some migrations may annotate your codebase with tasks for completion that you can find by searching for `@migration`.
2828

29+
## Documentation
30+
31+
[Documentation](https://svelte.dev/docs/cli/sv-migrate)
32+
2933
## Changelog
3034

3135
[The Changelog for this package is available on GitHub](https://github.com/sveltejs/kit/blob/main/packages/migrate/CHANGELOG.md).

0 commit comments

Comments
 (0)