Skip to content

Commit

Permalink
chore: improve readme (#158)
Browse files Browse the repository at this point in the history
* chore: improve readme

* remove community adders from root readme

* remove `@latest` tag

* Update packages/cli/README.md

Co-authored-by: Ben McCann <[email protected]>

---------

Co-authored-by: AdrianGonz97 <[email protected]>
Co-authored-by: Ben McCann <[email protected]>
  • Loading branch information
3 people authored Oct 17, 2024
1 parent 7081e7a commit ccf9acc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ Read the [SvelteKit documentation](https://svelte.dev/docs/kit) for more details
| ------------------ | -------------------------------------- |
| [sv](packages/cli) | [Changelog](packages/cli/CHANGELOG.md) |

## Community adders

Get started on [creating your own community adder](/community-adder-template/README.md).

[Additional adders](https://www.sveltesociety.dev/packages?category=svelte-add) are maintained by the community.

## Contributing

Please file an issue for discussion before sending a PR for a new adder. Most new adders will likely be recommended to be implemented as community adders. This repository will only hold a very limited number of adders at the maintainers discretion that address widely held needs, are considered best-in-class, and are widely used in the Svelte community.
Expand Down
8 changes: 5 additions & 3 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# sv - the Svelte CLI

A command line interface (CLI) for creating and maintaining [Svelte](https://svelte.dev) applications. Just run...
A command line interface (CLI) for creating and maintaining [Svelte](https://svelte.dev) applications. Just run:

```bash
npx sv
```

...and follow the prompts.

## Acknowledgements

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).

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).

## Changelog

[Changelog](./CHANGELOG.md)

## License

[MIT](../../LICENSE)

0 comments on commit ccf9acc

Please sign in to comment.