Quantcast

Add a README file

Adrian L Lange [01-11-15 - 20:17]
Add a README file
Filename
.pkgmeta
README.md
diff --git a/.pkgmeta b/.pkgmeta
index 229d9b7..a337ca7 100644
--- a/.pkgmeta
+++ b/.pkgmeta
@@ -15,5 +15,6 @@ manual-changelog:

 ignore:
     - .gitmodules
+    - README.md
     - CONTRIBUTING.md
     - embeds/oUF/utils
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6833f50
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# oUF P3lim
+
+This is an addon for the popular MMORPG "World of Warcraft".
+It can be downloaded at [Curse](http://curse.com/addons/wow/ouf-p3lim) or at [WoWInterface](http://wowinterface.com/downloads/info8455).
+
+## Description
+
+oUF P3lim is a layout made for the unitframe framework oUF.
+It is a personal layout, customized to my every need, and because of this I am not taking any feature requests.
+I've written this layout to be easily readable for those who would like to use it as a reference to their own layout(s).
+If you intend to use this layout or parts of it, please credit me for my work.
+
+It has the following features:
+
+- Minimalistic layout.
+- Supports most roles and playstyles, although designed around damage/tanking.
+- Completely stand-alone, oUF is embedded.
+- [oUF Experience](https://github.com/p3lim-wow/oUF_Experience/wiki) is embedded.
+- [oUF MovableFrames](https://github.com/haste/oUF_MovableFrames) is embedded (type `/pmf` to move).
+
+The following units are supported:
+
+- Player
+- Target
+- TargetTarget
+- Focus
+- Party/Raid
+- Pet (health value on player frame)
+- Boss
+- Arena (including preparation)
+
+The following class-specific powers are supported:
+
+- Death Knight's Runes
+- Druid's Eclipse
+- Monk's Chi
+- Paladin's Holy Power
+- Priest's Shadow Orbs
+- Rogue's Anticipation
+- Warlock's Soul Shards, Demonic Fury & Burning Embers
+
+Combo points are also supported for all classes and vehicles.
+
+## Feedback
+
+If you have a question, please use the comments section on Curse/WoWInterface.
+If you would like to report a bug, please follow [this link](https://github.com/p3lim-wow/oUF_P3lim/blob/master/CONTRIBUTING.md) to get started.
+
+## Legal
+
+Please see the [LICENSE](https://github.com/p3lim-wow/oUF_P3lim/blob/master/LICENSE.txt) file.