chore: add readme

This commit is contained in:
Alexander Daichendt 2022-07-29 23:10:48 +02:00
parent ca5aefc244
commit 40261c9f8c

View file

@ -1,28 +1,18 @@
# create-svelte
# Alex' small website
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
Link to the [website](https://daichendt.one)
## Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```bash
# create a new project in the current directory
npm init svelte
# create a new project in my-app
npm init svelte my-app
```
Powered by Svelte & SvelteKit
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Once you've created a project and installed dependencies with `yarn install`, start a development server:
```bash
npm run dev
yarn dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
yarn dev -- --open
```
## Building
@ -30,9 +20,7 @@ npm run dev -- --open
To create a production version of your app:
```bash
npm run build
yarn build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.