diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..5fa0e30 --- /dev/null +++ b/readme.md @@ -0,0 +1,18 @@ +# SGDB Button on Steam + +A simple browser extension that adds a button on Steam pages that links to their SteamGridDB entry. + +## Installation + +You can download it for Firefox [here](https://addons.mozilla.org/en-US/firefox/addon/sgdb-button-on-steam/). + +If you want to use it on Edge or Chrome, you will have to manually install it instead. + +I'm still awaiting verification to publish on the Edge Add-ons site, and I don't want to pay to publish it on the Chrome Web Store. + +### Manual Install: +1. Start by downloading the latest release from [here](https://gitea.goblincave.synology.me/Nes/SGDB-Extension/releases). +2. Unpack the ZIP archive in a location of your choosing. +3. Navigate to `edge://extensions` or `chrome://extensions` +4. Enable "Developer mode" +5. Press "Load unpacked" and select the folder where you unzipped the extension.