add README.md

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..486360b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# WebTray
+
+This project helps you to create web-apps which you can dock into the systray.
+
+## Usage
+
+```sh
+webtray <url> [--hidden]
+```
+
+If you use `--hidden` it will start in the systray.
+
+## Build
+
+### Dependencies
+
+```
+Qt6 Qt6WebEngine
+```
+
+To install them run the following on Arch-Linux
+
+```sh
+pacman -Sy qt6 qt6-webengine
+```