chore: update readme

This commit is contained in:
Guz013
2023-05-29 14:06:21 -03:00
parent 2467d4be71
commit 0d33fbc1f6

View File

@@ -1,38 +1,5 @@
# create-svelte
# Twooth
> Even being functional, this project will be totally rewritten in the future for better scalability, accessibility and better implementation of features
> Judge this 1.0 version as still an Minimal Viable Product made for myself.
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
## 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 create svelte@latest
# create a new project in my-app
npm create svelte@latest my-app
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
To create a production version of your app:
```bash
npm run 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.
An webapp created for posting on Twitter and Mastodon from one single page.