From 79c489f37e4bc3c75e187eab8f795a49c3b748f3 Mon Sep 17 00:00:00 2001
From: alexfriesen <friesen.alex.home@gmail.com>
Date: Thu, 14 Nov 2024 10:49:48 +0100
Subject: [PATCH] docs: add basic readme

---
 README.md | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3291692..78f3ec5 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,41 @@
-# zeity
+# Zeity
+
+Zeity is a productivity app focused on time tracking, managing projects and getting things done.
+
+This project is in an early stage of development.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js
+- pnpm
+
+### Running the Application
+
+To start the development server, run:
+
+```sh
+pnpm dev
+```
+
+Building the Application
+To build the application for production, run:
+
+```sh
+pnpm build
+```
+
+Linting
+To lint the code, run:
+
+```sh
+pnpm lint
+```
+
+Testing
+To run the tests, run:
+
+```sh
+pnpm test
+```