aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2015-10-13 18:22:09 +0100
committerRichard van der Hoff <richard@matrix.org>2015-10-13 18:22:09 +0100
commitc4a08cea39c2fc2475845fa9163cefca30221612 (patch)
treed1a6640bb8feceea00414b6bbf1cdc227d7936f2 /README.md
parent3b0c7c0469c1176eae75f92e33f40bdc088cbb4f (diff)
downloadpurple-matrix-c4a08cea39c2fc2475845fa9163cefca30221612.tar.gz
Update readme
Add some notes about installing
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5967cec..e40920f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
# purple-matrix
-Libpurple protocol plugin for matrix
+
+This project is a plugin for
+[libpurple](https://developer.pidgin.im/wiki/WhatIsLibpurple) which adds the
+ability to communicate with [matrix.org](http://matrix.org) homeservers to any
+libpurple-based clients (such as [Pidgin](www.pidgin.im)).
+
+# Installation
+
+Using this on Linux should be as simple as:
+
+```
+make
+sudo make install
+```
+
+You will then need to restart Pidgin, after which you should be able to add a
+'Matrix' account.