diff --git a/README.md b/README.md index 91a67a4..6fadefa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# tokens +# Image Tagger +A Foundry VTT module to help you find images that fit what you're wanting faster! +## How It Works +When you upload a new image using the module, you can give it: +- a name +- any number of tags +- any number of artists + +Then, when you are looking for an image for something, you can use the integrated +Art Browser in order to search based on name, tags, and/or artists! + +## Image Optimization +Included in the module is an automatic conversion of any static images (png, jpeg, +etc.) into an optimized webp format! If you upload a webp or gif image, they will +not be converted at all, they will stay how you have them. + +This optimization is done so that the storage on your server or computer is reduced, +as well as making it so all of the images load faster on your player's computers. + +# Disclaimer: +This module is currently in beta testing, as such there may be bugs and missing +features. To report bugs or request features you can open an issue on the +[Public Issue Tracker](https://git.varify.ca/Foundry/image-tagger/issues) or you +can send an email to [hello@varify.ca](mailto:hello@varify.ca). diff --git a/module.json b/module.json index 4cb38e7..478eba3 100644 --- a/module.json +++ b/module.json @@ -9,9 +9,10 @@ "maximum": 13 }, "authors": [ - { "name": "Oliver" } + { "name": "Oliver", "email": "hello@varify.ca" } ], "url": "https://git.varify.ca/Foundry/image-tagger", + "bugs": "https://git.varify.ca/Foundry/image-tagger/issues", "manifest": "", "download": "", "esmodules": [