add README.md

1 files changed, 9 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..90ce8d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# wayland-sandbox
+
+A trivial program to create a wayland security context.
+
+It works by creating a unix socket, setting it to listen, and registering the socket with the
+wayland security context API. 
+
+This program is does not create a sandbox on its own, and should be used in combination
+with bwrap or similar utils.