From df6eba43dae11ba55ce79d94558610f7b422c670 Mon Sep 17 00:00:00 2001 From: Adrian L Lange Date: Sun, 11 Jan 2015 20:57:44 +0100 Subject: [PATCH] Add a README file --- .pkgmeta | 1 + README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 README.md diff --git a/.pkgmeta b/.pkgmeta index 026356e..9e63a03 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..5a1aa0b --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# QuickQuest + +This is an addon for the popular MMORPG "World of Warcraft". +It can be downloaded at [Curse](http://curse.com/addons/wow/quickquest) or at [WoWInterface](http://wowinterface.com/downloads/info20838). + +## Description + +QuickQuest is a quest automating addon that will do the most enduring questing tasks for you. +It allows the player to quickly accept and deliver quests, among other features, to speed up the questing experience. + +It comes with a solid set of options, accessible through typing `/quickquest` or simply `/qq` in the chat. + +It has the following features: + +- Automatically pick up any quest. +- Automatically deliver any quest. +- Automatically use items that starts a quest. + - Item filter in the options for blacklisting certain items. +- Automatically skip single gossip options. +- Automatically pick up trivial quests. + - Only works if the player is tracking trivial quests through the minimap. +- Highlights the most valuable quest rewards. +- Holding shift will temporarily disable the automating. + +## Translating + +If you'd like to help translate this project, please follow this link: +http://wow.curseforge.com/addons/quickquest/localization/ + +## 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/QuickQuest/blob/master/CONTRIBUTING.md) to get started. + +## Legal + +Please see the [LICENSE](https://github.com/p3lim-wow/QuickQuest/blob/master/LICENSE.txt) file. -- 1.7.9.5