From 301bc9f51aace17e5b0f4bc21ee7c4f1d8fa7dee Mon Sep 17 00:00:00 2001 From: 409 <409dev@protonmail.com> Date: Tue, 8 Apr 2025 00:17:09 +0200 Subject: [PATCH] update README --- README.md | 40 ++++------------------------------------ 1 file changed, 4 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index b5b2950..c216699 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,6 @@ -# sv +# groove-web -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +An audio player for local files. Uses [SvelteKit](https://svelte.dev/) and [shadcn-svelte](https://www.shadcn-svelte.com/). -## 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 -npx sv create - -# create a new project in my-app -npx sv create 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://svelte.dev/docs/kit/adapters) for your target environment. +> [!NOTE] +> This is merely the frontend, for the backend see [groove](https://github.com/4-0-9/groove).