Quantcast

Add a README file

Adrian L Lange [01-11-15 - 20:47]
Add a README file
Filename
.pkgmeta
README.md
diff --git a/.pkgmeta b/.pkgmeta
index f7c6d78..d8eb307 100644
--- a/.pkgmeta
+++ b/.pkgmeta
@@ -5,4 +5,5 @@ manual-changelog:
     markup-type: markdown

 ignore:
+    - README.md
     - CONTRIBUTING.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef9d794
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# oUF Reputation
+
+This is an addon for the popular MMORPG "World of Warcraft".
+It can be downloaded at [Curse](http://curse.com/addons/wow/ouf-reputation) or at [WoWInterface](http://wowinterface.com/downloads/info12017).
+
+## Description
+
+oUF Reputation is a element plug-in made for the unitframe framework oUF.
+It does nothing by itself, and requires a layout that supports it to function.
+
+It has the following features:
+
+- Reputation bar.
+- Tags.
+
+For details on how to implement this in your own layout, please see the wiki:
+https://github.com/p3lim-wow/oUF_Reputation/wiki
+
+## Feedback
+
+If you have a question, please use the comments section on Curse/WoWInterface.
+If you would like to report a bug or contribute to the project, please follow [this link](https://github.com/p3lim-wow/oUF_Reputation/blob/master/CONTRIBUTING.md) to get started.
+
+## Legal
+
+Please see the [LICENSE](https://github.com/p3lim-wow/oUF_Reputation/blob/master/LICENSE.txt) file.