From b95b217c0a9806b8c8ec066510adf54b903dc20d Mon Sep 17 00:00:00 2001
From: PureTryOut <bart.ribbers@openmailbox.org>
Date: Sat, 8 Jul 2017 16:39:35 +0200
Subject: Add required repo files, and add the nheko client

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3fb24de..8a9ab74 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
-# matrix-overlay
-Gentoo overlay containing clients and servers for the Matrix protocol
+# Matrix Gentoo overlay
+
+This Gentoo overlay contains clients and servers for the Matrix protocol
+
+## Installation
+
+Install this overlay like any other.
+
+* Install [`layman`](https://wiki.gentoo.org/wiki/Layman), Gentoo's official overlay manager.
+
+```
+# emerge --ask app-portage/layman
+```
+
+* Add the `matrix` overlay
+
+```
+# layman -a matrix
+```
+
+* Synchronize overlays
+
+```
+# layman -S
+```
+
+## Contributing
+
+Don't hesitate to create a PR for any other Matrix clients, servers and other services!
+
+You can report any ebuild issues or feature requests in the [issue tracker](https://github.com/puretryout/matrix-overlay/issues).
-- 
cgit v1.2.3-65-gdbad