From 8fac6408ad09529c0d0f709b557d10472e2bac39 Mon Sep 17 00:00:00 2001
From: Santiago Lo Coco <se23m504@technikum-wien.at>
Date: Tue, 23 Apr 2024 18:00:44 +0200
Subject: [PATCH] Update README.md

---
 README.md | 44 ++++++++++++++++----------------------------
 1 file changed, 16 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 5ce6766..b297fe9 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,26 @@
-# create-svelte
+# BreakOften
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+BreakOften is a simple web application built with Svelte that helps users prevent computer vision syndrome by reminding them to take regular breaks.
 
-## Creating a project
+## Features
 
-If you're seeing this, you've probably already done this step. Congrats!
+- Regular mini breaks every 20 minutes and 20 seconds.
+- After every three mini breaks, a long break of 5 minutes is provided.
+- Users can skip or postpone breaks.
+- Customizable break durations.
+- Sound and notification alerts for break reminders.
 
-```bash
-# create a new project in the current directory
-npm create svelte@latest
+## Usage
 
-# create a new project in my-app
-npm create svelte@latest my-app
+1. Clone and cd into the repository.
+2. Install dependencies:
+
+```
+npm install
 ```
 
-## Developing
+3. Run the development server:
 
-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.