From 496ee97d3fe47483caf88540614bfbb3f45bbb57 Mon Sep 17 00:00:00 2001
From: Sebastian Lenzlinger <74497638+sebaschi@users.noreply.github.com>
Date: Tue, 13 Jun 2023 12:47:45 +0200
Subject: [PATCH] Update Readme

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3ec41ec..12e4376 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
-# keylogger-detector
-University project for an Operating Systems lecture. The goal is to develope a keystroke-logger-detector for a Linux environment. Developement Environment: Fedora 37 VM under  Gnome on VirtualBox. A project journal can be found [here](https://github.com/sebaschi/keylogger-detector/blob/main/doc/dev_journal.md)
+# KLDetect
+KLDetect is a keylogger detector for the Linux Desktop.
+It can detect processes reading from ```/dev/input/event*``` devices and kernel modules registered to listen to keyboard events.
+
+# Dependencies
+[Python](https://www.python.org/downloads/)
+[SystemTap](https://sourceware.org/systemtap/wiki)
+
+# Setup
+Download or clone this repository:
+```
+git clone https://github.com/sebaschi/keylogger-detector.git
+```
+
+Run a keylogger. KLDetect has been tested and shown to work on the following keylogger.
+User progams:
+* [simple-key-logger](https://github.com/gsingh93/simple-key-logger/tree/master)
+* [logkeys](https://github.com/kernc/logkeys)
+* [keylog](https://github.com/SCOTPAUL/keylog)
+Kernel Module:
+* [spy](https://github.com/jarun/spy)
+
+# Developers
+Copyright 2023 [Michel Romancuk](https://github.com/SoulKindred), [Sebastian Lenzlinger](https://github.com/sebaschi)
+
+
+
+
+
+This project is Part of a Univeristy project at the [Operating Systems](https://dmi.unibas.ch/de/studium/computer-science-informatik/lehrangebot-fs23/vorlesung-operating-systems-1/) lecture at the University of Basel, Switzerland.
+ A project journal can be found [here](https://github.com/sebaschi/keylogger-detector/blob/main/doc/dev_journal.md)