OSDN Git Service

updated README
authorJohn-Anthony Elenis <johnanthonyelenis@gmail.com>
Mon, 26 Aug 2019 13:35:32 +0000 (09:35 -0400)
committerJohn-Anthony Elenis <johnanthonyelenis@gmail.com>
Mon, 26 Aug 2019 13:35:32 +0000 (09:35 -0400)
README.md
doc/example_01.PNG
doc/example_02.PNG
doc/example_03.PNG [deleted file]

index c18f77f..61a7000 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,14 @@
-# $name
-###  A customizable interface for lightdm-webkit2-greeter
-![](doc/example.gif)
+# Greeter.js
+####  A lightweight framework to help create high quality greeter themes for  Lightdm Webkit2.
+
+## Description
+### Easily create  your own Linux greeter
+
+![preview](doc/example.gif)
 ## Examples
+![splash-screen-sample](doc/example_01.png)
+
+![splash-screen-sample](doc/example_02.png)
 
 ## Installation
 Install the lightdm and its webkit greeter, make sure that no other version of lightdm is installed on your system.
@@ -26,16 +33,16 @@ Next clone the this repo and copy it to the webkit2 themes folder. (You will nee
 root permission for the copy)
 
 ```
-$ git clone https://github.com/jelenis/$name.git
+$ git clone https://github.com/jelenis/greeter.js.git
 # cp -r lightdm-theme /usr/share/lightdm-webkit/themes/
 ```
 
-Lastly, set the value of theme in `/etc/lightdm/lightdm-webkit2-greeter.conf` to $name
+Lastly, set the value of theme in `/etc/lightdm/lightdm-webkit2-greeter.conf` to greeter.js
 
 ```
 [greeter]
 ...
-webkit_theme = $name
+webkit_theme = greeter.js
 ```
 ## Usage
 ### Basic Usage
index d383e60..4da8125 100644 (file)
Binary files a/doc/example_01.PNG and b/doc/example_01.PNG differ
index dfb2e0c..766aad6 100644 (file)
Binary files a/doc/example_02.PNG and b/doc/example_02.PNG differ
diff --git a/doc/example_03.PNG b/doc/example_03.PNG
deleted file mode 100644 (file)
index 57943f5..0000000
Binary files a/doc/example_03.PNG and /dev/null differ