From 306815c3aed4ff3604f610278dec66ed9c778120 Mon Sep 17 00:00:00 2001 From: jasper Date: Sun, 19 Jan 2025 00:22:56 +0100 Subject: [PATCH] updated README.md --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c6d12a..e10a00e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ -# schoolplanner +# **School Planner** 📚 -Ein gut benutzbarer schoolplanner mit vielen einfachen features mit Frontend (Flet) und backend (Fastapi) \ No newline at end of file +Welcome to **School Planner**, a dynamic and feature-packed project that helps you manage your school schedule, tasks, and activities. Built with **FastAPI** and **Flet**, this app offers both a backend API and a frontend for an amazing user experience. + +## Table of Contents 📚 +- [Introduction](#introduction) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) +- [Statistics](#statistics) +- [Contributing](#contributing) +- [License](#license) + +## Introduction ✨ + +**School Planner** is a comprehensive tool designed to streamline your academic life. It allows you to plan and organize your daily activities, assignments, and events with ease. The project consists of a robust backend built with **FastAPI** and a beautiful frontend powered by **Flet**. + +## Features ⚡ + +Here are the key features of **School Planner**: +- **Interactive Dashboard**: View your upcoming assignments, exams, and activities in a single place 📅. +- **Task Management**: Add, update, and remove tasks to stay on top of your assignments and deadlines 📝. +- **Calendar View**: Visualize your schedule and plan ahead with a calendar interface 📆. +- **Notifications**: Get reminders for upcoming deadlines and events 🔔. +- **Responsive Design**: The frontend is designed to work seamlessly across devices and platforms 💻📱. + +## Installation ⚙️ + +To get started with **School Planner**, follow these simple installation steps: + +1. Clone the repository: + ```bash + git clone https://gitea.grevsmuehl.org/jasper/schoolplanner.git