From 252ea41edec1e4db3a6cfed4cc115fe69ac9a0c6 Mon Sep 17 00:00:00 2001
From: itsscb <dev@itsscb.de>
Date: Sat, 26 Jul 2025 22:09:30 +0200
Subject: [PATCH] docs: update readme

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 61 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8b32494..5629b46 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,62 @@
-# lw
+# lw - CLI Personal Log Manager
 
-cli tool to log your work
\ No newline at end of file
+`lw` is a terminal-based tool for creating and managing personal logs directly from the command line. It enables you to quickly record, edit, and review your achievements, notes, or any personal entries using an interactive text user interface (TUI).
+
+---
+
+## Features
+
+- Create and maintain a personal log of accomplishments, notes, or reflections  
+- Interactive terminal UI with keyboard-driven navigation and editing  
+- Add, edit, and remove entries via popup editor  
+- Entries are timestamped and sorted by creation date (most recent first)  
+- Persistent storage of logs in a JSON file under a platform-specific config directory  
+- Lightweight and easy to use from any terminal session  
+
+---
+
+## Installation
+
+Download a binary from the Releases page or build from source.
+
+### Prerequisites
+
+- Rust toolchain (1.88+ recommended)  
+- Cargo package manager  
+
+### Build from source
+
+Clone the repository and build:
+
+`git clone https://git.itsscb.de/itsscb/lw.git`  
+`cd lw`  
+`cargo build --release`
+
+The compiled binary will be located at `target/release/lw`.
+
+---
+
+## Usage
+
+Run the application from the terminal:
+
+`./target/release/lw`
+
+## Data Storage
+
+Your personal log entries are saved in a JSON file named `lw.json` located in the platform-specific configuration directory:
+
+- **Windows:** `%APPDATA%\lw\config.json`  
+- **Unix/Linux/macOS:** `$HOME/.config/lw/config.json`  
+
+The directory and file are created automatically on first run.
+
+---
+
+## Contributing
+
+Contributions, bug reports, and feature requests are welcome. Please open issues or submit pull requests.
+
+---
+
+For support or questions, please refer to the project repository.