Add readme

This commit is contained in:
Tyler Hallada 2022-03-23 23:55:18 -04:00
parent 82ce637c3b
commit 0100ab0974

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# Modmapper integration for Vortex
Adds "See on Modmapper" buttons to Skyrim mods and plugins in [Vortex](https://www.nexusmods.com/about/vortex/) which open the [Modmapper](https://modmapper.com) web page for the mod/plugin.
## Installation
### For general use
Checkout the extension mod on [Nexus Mods](https://www.nexusmods.com/site/) to install via Vortex automatically.
### For development
Checkout the repo and then run:
```
yarn install
yarn build
```
Package the contents of the `dist` folder into an archive and drag and drop it into the Vortex extensions page.
## Acknowledgements
Thanks to Pickysaurus for creating the initial extension and helping out with development.