From 3c76c33835abc709403129f4272c5c22bdf5f590 Mon Sep 17 00:00:00 2001 From: Andri Yngvason Date: Fri, 17 Jan 2020 07:58:16 +0000 Subject: [PATCH] README: Improve introduction --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 494a9cf..af4faff 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # wayvnc ## Introduction -This is a VNC server for wlroots based Wayland compositors. +This is a VNC server for wlroots based Wayland compositors. It attaches to a +running Wayland session, creates virtual input devices and exposes a single +display via the RFB protocol. The Wayland session may be a headless one, so it +is also possible to run wayvnc without a physical display attached. ## Building ### Runtime Dependencies