Quantcast

create initial README file

Kevin Gilbert [08-25-16 - 21:49]
create initial README file
Filename
README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..afa957c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# ArtifactMenu
+
+This is a simple World of Warcraft add-on to automate opening the Artifact interface in the upcoming expansion *Legion*. It is my first add-on and was never intended to be particularly complex. The whole point is that:
+
+1. To open the Artifact interface, you must Shift+RightClick on your equipped Artifact weapon
+2. It is easier to type `/run SocketInventoryItem(16);`, if you can save it to a macro
+3. It is more intuitive to type `/am` or `/artifact` than the above macro
+4. Some artifacts are off-hands and require inventory slot #17
+
+This add-on will simplify all of that to just:
+
+* `/artifact`
+* `/am` (if you're lazy)
+* `/artifactmenu` (if you're forgetful)
+
+# Special Thanks
+
+* [The idea](https://www.reddit.com/r/wow/comments/4ze7uw/psa_macro_to_quickly_open_the_artifact_weapon/) by [/u/HoLeeSchit](https://www.reddit.com/user/HoLeeSchit)
+* [WoW Addon Writing Guide](http://wow.gamepedia.com/User:Cogswobble/Addon_Tutorial/Slash_Commands) by Cogswobble
+* Wowpedia [slash commands reference](http://wow.gamepedia.com/Creating_a_slash_command)
+* The nice people of [#wowuidev](http://us.battle.net/forums/en/wow/topic/1127130079) for helping me debug
+