aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e7caf1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Tag Tooltip
+
+This mod adds a tooltip to every item which shows every tag an that item has. It was primarily created to be used in conjunction with Mekanisms Tag filter, which allows to tell machines on which items to operate. Since Mekanism didn't provide information how to get those tags, i created this mod to help with that.
+
+## Added Features
+
+ - Keybind "Show Ore Dictionary / Item Tags" under the "Inventory" category
+ - This keybind shows the tags when hovering over an item
+ - Can be installed Client side only, and doesn't provide any benefit if installed on the server.
+ - That's it, it's a small mod, maybe I'll add in more tooltips if I can think of any.
+
+## Links
+
+ - [Bug Tracker](https://github.com/romangraef/tagtooltip/issues)
+ - [Github](https://github.com/romangraef/tagtooltip)
+ - [My Twitter](https://twitter.com/romangraef89)