-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
008c83b
commit 0cc1d56
Showing
1 changed file
with
2 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,3 @@ | ||
# sv - the Svelte CLI | ||
# @svelte-cli/create | ||
|
||
A CLI for creating new [SvelteKit](https://kit.svelte.dev) projects and adding functionality to existing ones. Just run... | ||
|
||
```bash | ||
npx sv | ||
``` | ||
|
||
...and follow the prompts. | ||
|
||
## API | ||
|
||
You can also use `sv` programmatically: | ||
|
||
```js | ||
import { create } from 'sv'; | ||
|
||
await create('my-new-app', { | ||
name: 'my-new-app', | ||
template: 'default' // or 'skeleton' or 'skeletonlib' | ||
}); | ||
``` | ||
|
||
`checkjs` means your project will use TypeScript to typecheck JavaScript via [JSDoc comments](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html). | ||
|
||
## 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). | ||
|
||
## License | ||
|
||
[MIT](../../LICENSE). | ||
An internal package for scaffolding SvelteKit projects. |