From bebb9072ae8dd5467618403d8697701d9f58ce8b Mon Sep 17 00:00:00 2001
From: Simeon Simeonov
Date: Tue, 14 Apr 2020 15:29:38 +0200
Subject: Fix documentation and release version typo

---
 README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 56 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index dec2154..7529f4c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-## i3lock-extended
+# i3lock-extended
 
 i3lock-extended is a fork of i3lock (https://github.com/i3/i3lock).
-It was started by Simeon Simeonov (https://simeon.simeonov.no) as a small hack, 
+It was started by Simeon Simeonov (sgs @ Freenode) as a small hack, 
 implementing a LED-clock on top of an existing and robust screensaver.
 
 i3lock-extended adds some additional functionality and is a free-software
@@ -12,7 +12,7 @@ The original README.md file from i3lock, containing installation instructions
 can be found as INSTALL.md.
 
 
-### Additional features
+## Additional features
 
 - LED-clock
 - Digital clock
@@ -24,7 +24,7 @@ i3lock-extended includes all of the original code and features of i3lock.
 Please refer to the manual page for more details and information about the different parameters\!
 
 
-### Versioning
+## Versioning
 
 i3lock-extended will merge the changes and fixes coming to i3lock in the
 future.
@@ -32,3 +32,55 @@ future.
 In order to create more clarity the version format for i3lock-extended will be:
 \<extended version starting from 1>.\<i3lock version that is merged in\>[a-z
 extended revision if used].
+
+
+## Installation
+
+### Gentoo
+
+   ```bash
+   layman -a sgs
+   emerge x11-misc/i3lock-extended
+   ```
+
+
+### From source
+
+   ```bash
+   wget https://simeon.simeonov.no/programs/i3lock_extended/downloads/i3lock-extended-\<version\>.tar.xz
+   tar Jxvf i3lock-extended-\<version\>.tar.xz && cd i3lock-extended-\<version\>
+   ./configure --prefix=/usr --sysconfdir=/etc --disable-sanitizers
+   make
+   # make install
+   ```
+
+
+### From git
+
+   ```bash
+   git clone https://github.com/blackm0re/i3lock-extended.git && cd i3lock-extended
+   autoreconf --force --install
+   ./configure --prefix=/usr --sysconfdir=/etc --disable-sanitizers
+   make
+   # make install
+   ```
+
+
+## Support and contributing
+
+i3lock-extended is hosted on GitHub: https://github.com/blackm0re/i3lock-extended
+
+
+## Author
+
+Simeon Simeonov - sgs @ Freenode
+
+
+## [License](https://github.com/blackm0re/i3lock-extended/blob/master/LICENSE)
+
+Copyright 2020 Simeon Simeonov
+
+Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html
+
+This software includes software copyrighted by Michael Stapelberg and
+distributed under a different license: See LICENSE for more information!
-- 
cgit v1.3