Skip to content

Add create-svelte README #4951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benmccann merged 2 commits into from
May 16, 2022
Merged

Add create-svelte README #4951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
023ce8a
add create-svelte README
Rich-Harris May 16, 2022
81396ca
format
Rich-Harris May 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/beige-mails-accept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'create-svelte': patch
---

Add README
32 changes: 32 additions & 0 deletions packages/create-svelte/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# create-svelte

A CLI for creating new [SvelteKit](https://kit.svelte.dev) projects. Just run...

```bash
npm init svelte
```

...and follow the prompts.

## API

You can also use `create-svelte` programmatically:

```js
import { create } from 'create-svelte';

await create('my-new-app', {
name: 'my-new-app',
template: 'default', // or 'skeleton'
types: 'checkjs', // or 'typescript' or null;
prettier: false,
eslint: false,
playwright: false
});
```

`checkjs` means your project will use TypeScript to typecheck JavaScript via [JSDoc comments](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html).

## License

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