From 4e32589ce679fa21eae8c61f0b2aa072b9f24481 Mon Sep 17 00:00:00 2001 From: Markus Brueckner Date: Sun, 15 Dec 2024 09:17:06 +0100 Subject: [PATCH] add preliminary README --- README.md | 39 ++++----------------------------------- 1 file changed, 4 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index b5b2950..420e246 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,7 @@ -# sv +# Three60 -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +A very, very simple 360° review tool. Supports self-registration of users and limiting the registration to certain email address domains. -## Creating a project +## Caution -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. +This is just a toy for me to experiment with SvelteKit and a few other libraries. This is nowhere near production-ready! \ No newline at end of file