From 55b6e7dbf7deef90a455299be5b27b1c38317925 Mon Sep 17 00:00:00 2001
From: 1024x2
Date: Wed, 17 Jul 2024 00:09:52 +0100
Subject: Add key logging support

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index a83ecd0..0e54d2d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
 # vexnc
-Single-purpose VNC server that simply displays a static image to all clients.
+Dumb VNC server that simply displays a static image of your choosing to all clients on port 5900.
+It can also log keypresses to a file. Useful for catching bots that scan the entire internet for exposed VNC servers.
+
+## Usage
+Requires libvncserver.
+
+```
+$ make CFLAGS="-O2 -march=native"
+$ ./vexnc dipshit.png 'insert funny desktop name here' ~/vexnclogs
+```
+
+## TODO
+- Allow choosing other ports than 5900
+- Add compression to log files (you can just handle this with a cronjob though)
-- 
cgit v1.2.3