From c47510041f7909c697bc71e0efbc03e3759ca49a Mon Sep 17 00:00:00 2001
From: Phil Jones <philj56@gmail.com>
Date: Mon, 1 Nov 2021 10:19:05 +0000
Subject: Update README.

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e69de29..0c00515 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,39 @@
+# greetd-mini-wl-greeter
+
+An extremely simple raw Wayland greeter for greetd, inspired by
+[lightdm-mini-greeter](https://github.com/prikhi/lightdm-mini-greeter).
+
+![Screenshot](screenshot.png)
+
+## Usage
+
+Follow the same steps as for e.g. gtkgreet in the [greetd
+wiki](https://man.sr.ht/~kennylevinsen/greetd/). See the man page for sway
+config suggestions.
+
+## Install
+
+### Arch
+
+greetd-mini-wl-greeter is available on the
+[AUR](https://aur.archlinux.org/packages/greetd-mini-wl-greeter-git/):
+```sh
+paru -S greetd-mini-wl-greeter-git
+```
+
+### Source
+```sh
+meson build
+ninja -C build
+```
+
+## Tips
+
+It's quite entertaining to set the password character to one from the
+[combining diacritical
+marks] (https://en.wikipedia.org/wiki/Combining_Diacritical_Marks) page, e.g.
+```sh
+greetd-mini-wl-greeter -C ̣
+```
+
+![Combining diacritical screenshot](screenshot_vertical.png)
-- 
cgit v1.2.3