From 253b37b85d28ea580096d25d6a570d1dff3d0835 Mon Sep 17 00:00:00 2001 From: JezerM Date: Mon, 28 Jun 2021 21:31:03 -0600 Subject: [PATCH] Updated README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 63c38f1..7c4d157 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ # Web Greeter for LightDM -This is a try to update the [Antergos web-greeter](https://github.com/Antergos/web-greeter), following what they left, so all the credits should go with them. +A modern, visually appealing greeter for LightDM, that allows to create web based themes with HTML, CSS and JavaScript. + +This is a try to update the [Antergos web-greeter](https://github.com/Antergos/web-greeter), following what they left. As this is based on the [master release](https://github.com/Antergos/web-greeter/tree/master), which does some API changes, actual themes would need to do changes to work correctly. +## Features + +- Create themes with HTML, CSS and JavaScript! +- Should work everywhere. +- JavaScript error handling, allowing to load the default theme. +- Themes could be simple, or very complex. +- Battery and brightness control. + ## Dependencies | | arch | ubuntu | fedora | openSUSE | |-----------------------|---------------|----------------------|---------------------|-----------------------| @@ -25,7 +35,7 @@ cd web-greeter sudo make install ``` -## Theme Javascript API +## Theme JavaScript API [Antergos][Antergos] documentation is no longer available, although it is accesible through [Web Archive][WebArchive]. Actual documentation is available in [Gitbook][ApiDoc]. You can access the man-pages `man web-greeter` for some documentation and explanation. Also, you can explore the provided [themes][./themes] for real use cases.