Skip to content

Commit 99ec8d0

Browse files
committed
Prep for major
1 parent 81469d2 commit 99ec8d0

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# svelte-starter
1+
# sveltekit-starter
22

33
> Opinionated starter template for SvelteKit
44
@@ -20,24 +20,24 @@ This combo-patcher uses [zx](https://github.com/google/zx), so make sure that's
2020
run:
2121

2222
```
23-
$ zx --install https://raw.githubusercontent.com/zerodevx/sveltekit-starter/main/index.mjs <app-name> [flags]
23+
$ zx --install https://raw.githubusercontent.com/zerodevx/sveltekit-starter/main/index.js <app-name> [flags]
2424
```
2525

26-
This generates the starter based on the latest SvelteKit decisions, then saves the output to
26+
This generates the starter based on the last known SvelteKit decisions, then saves the output to
2727
`/app-name`.
2828

2929
### Flags
3030

3131
| Flag | Type | Default | Description |
3232
| ---- | -------------------------------------- | ---------- | ---------------------------------- |
33-
| -o | boolean | false | Overwrite existing path if exists. |
33+
| -o | boolean | false | Overwrite existing path if exists |
3434
| -t | ('skeleton'\|'skeletonlib'\|'default') | 'skeleton' | Base template from `create-svelte` |
3535

3636
## Opinions
3737

38-
### SvelteKit
38+
### Base
3939

40-
Base skeleton `create-svelte` template with JSDoc+Prettier+ESLint+Playwright.
40+
Base `create-svelte` skeleton template with `jsdoc`, `prettier`, `eslint` and `playwright`.
4141

4242
### Tailwind CSS
4343

@@ -50,6 +50,7 @@ both well, but spaces display better outside IDEs (I'm looking at you Github).
5050

5151
```json
5252
{
53+
// ...
5354
"printWidth": 100,
5455
"useTabs": false,
5556
"semi": false,
@@ -77,7 +78,7 @@ module.exports = {
7778

7879
### Static site setup
7980

80-
Seriously, don't use SSR unless you really need it. Installs `adapter-static` and adds sensible
81+
Seriously, don't use SSR unless you really need to. Installs `adapter-static` and adds sensible
8182
defaults.
8283

8384
## License

package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
{
2-
"name": "@zerodevx/svelte-starter",
3-
"version": "1.0.0",
2+
"name": "@zerodevx/sveltekit-starter",
3+
"version": "2.0.0",
44
"description": "Opinionated starter template for SvelteKit",
55
"author": "Jason Lee <[email protected]>",
66
"scripts": {
7+
"start": "zx index.js temp -o",
78
"format": "prettier --ignore-path .gitignore --write ."
89
},
910
"devDependencies": {
1011
"create-svelte": "^3.1.0",
1112
"prettier": "^2.8.4"
1213
},
13-
"main": "index.mjs",
14+
"type": "module",
15+
"main": "index.js",
1416
"license": "ISC",
15-
"repository": "github:zerodevx/svelte-starter"
17+
"repository": "github:zerodevx/sveltekit-starter"
1618
}

0 commit comments

Comments
 (0)