summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPhil Jones <philj56@gmail.com>2021-11-01 11:23:43 +0000
committerPhil Jones <philj56@gmail.com>2021-11-01 11:40:28 +0000
commit8fc10eae44b388bee9e5bfdbc0a59c6c7d69ddd8 (patch)
tree13c9b0b4db1110a1ed39e3c7d4fc8ea5b99faca8 /README.md
parentc47510041f7909c697bc71e0efbc03e3759ca49a (diff)
Add manpage and usage help.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0c00515..519b976 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
# greetd-mini-wl-greeter
-An extremely simple raw Wayland greeter for greetd, inspired by
+An extremely simple raw Wayland greeter for
+[greetd](https://sr.ht/~kennylevinsen/greetd/), inspired by
[lightdm-mini-greeter](https://github.com/prikhi/lightdm-mini-greeter).
![Screenshot](screenshot.png)
@@ -8,8 +9,9 @@ An extremely simple raw Wayland greeter for greetd, inspired by
## 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.
+wiki](https://man.sr.ht/~kennylevinsen/greetd/). See the man page for
+configuration options. All colors and sizes can be customised, and a PNG
+background image can be displayed scaled and centered.
## Install