Quantcast

Add README file

Andrew Mordecai [07-14-16 - 01:10]
Add README file
Filename
README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e28985
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+SilverDragon Overlay
+====================
+
+SilverDragon already talks to NPCScan.Overlay and tells it which mob paths to
+show on the map. This addon makes it talk a little more, and remove paths for
+mobs after you've killed them, tidying up the map.
+
+SilverDragon Overlay relies on achievement and quest data fetched from the game
+client, so it won't ever hide paths for some really old rares.
+
+
+Contributing
+------------
+
+If you've discovered a bug in this addon, you can let me know about it by:
+
+- opening a ticket on the [GitLab project page](https://gitlab.com/akkorian/silverdragon-overlay/issues)
+- emailing me at <armordecai@protonmail.ch>
+- sending me (Akkorian) a private message on WoWInterface
+
+Be sure to include which version of the add-on you're using, and the name
+and version of the Broker display you're using!
+
+
+Legal
+-----
+
+This add-on is published under the zlib/libpng license. See the included
+LICENSE.txt file for more details.
+