diff --git a/README.md b/README.md index 32687dd..cc544ea 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ ![ALTTP - Tracker](https://github.com/thecodeflayer/alttp-tracker/blob/master/assets/feature_graphic.png) +# EXCITING NEWS! +I've rewritten the tracker as a progressive web app. You can now access the tracker at [alttprtracker.com](https://alttprtracker.com) + # alttp-tracker A mobile app for tracking ALTTP randomizer runs. You can track items collected, dungeon items and bosses and view available locations on the Light World and Dark World maps. @@ -9,14 +12,20 @@ The tracker currently supports [Standard, Inverted and Retro](https://github.com [Entrance Shuffle BETA](https://github.com/thecodeflayer/alttp-tracker/blob/master/FAQ.md#entrance-shuffle-settings) support has recently been added! ## Supported Platforms -Currently, I'm only building APKs for Android. I still need to figure out how to build for iOS. +The old tracker app currently only supports Android. Please check out the new progressive web app at [alttprtracker.com](https://alttprtracker.com) ## Found a bug? Want a feature? Please file an [issue](https://github.com/thecodeflayer/alttp-tracker/issues)! First take a look at existing issues and make sure that it hasn't been filed before. Include descriptive information about the issue and screenshots if possible. Also include the version of the app that you're using. -## Installation +## Progressive Web App Installation Instructions +You can add the progressive web app to your device by following these instructions. +1. On your device, open your favorite browser and navigate to [alttprtracker.com](https://alttprtracker.com) +2. Open the browser menu. There will be an option to add the app to the home screen or install. The label is dependent on the browser. +3. Once added the application should function just like a native application. + +## Old Installation Instructions In order to install on Android you will have to "side-load" the APK from Github. On most modern Android platforms you can follow these steps: 1. Navigate to the latest release page on the Android device you want to install the app on. Current release is [1.2.0](https://github.com/thecodeflayer/alttp-tracker/releases/tag/1.2.0)