Quantcast

Add a README file

Adrian L Lange [01-11-15 - 18:27]
Add a README file
Filename
.pkgmeta
README.md
diff --git a/.pkgmeta b/.pkgmeta
index 414c413..5f1b3a5 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..c4be602
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# BonusRollPreview
+
+This is an addon for the popular MMORPG "World of Warcraft".
+It can be downloaded at [Curse](http://curse.com/addons/wow/bonusrollpreview) or at [WoWInterface](http://wowinterface.com/downloads/info22213).
+
+## Description
+
+BonusRollPreview allows you to see at a blance what the possible yields from a bonus roll would be.
+When the bonus roll window shows up, press the arrow button to show a quick preview of items.
+You can also change your spec priority right from the window, see the button in the top left corner.
+
+So, from now on you don't have to alt-tab to a browser or open the Encounter Journal while on limited time.
+
+This addon was made based on an idea posted on [reddit](http://reddit.com/r/wow/comments/1b79zj/addon_idea_after_you_killed_a_boss_you_will_see_a/).
+
+## 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/BonusRollPreview/blob/master/CONTRIBUTING.md) to get started.
+
+## Legal
+
+Please see the [LICENSE](https://github.com/p3lim-wow/BonusRollPreview/blob/master/LICENSE.txt) file.