Skip to content

SlyAceZeta/Ribbons.Guide

Repository files navigation

Current Data
GPL-3.0 license GitHub Workflow Status W3C Validation

Ribbons.Guide is a progressive web app that allows you to keep track of your Pokémon and their Ribbons! Ribbons.Guide doesn't store or send any data anywhere—it's all saved on your device!

How to Use

Regardless of how you use Ribbons.Guide, all data is stored in your browser's local storage. A backup and restore option is available in the Settings menu, allowing you to transfer your data between browsers or installations.

  • Ribbons.Guide is available online through this repository's attached GitHub Pages deployment. Simply visit https://ribbons.guide to get started! This is always up-to-date.
  • Ribbons.Guide can be installed as an app, which also works offline! Visit https://ribbons.guide in a supported browser and use the browser's menu to install the app onto your device, then open the app to get started! The app will automatically update itself when you open it while your device is online.
  • If you choose, you can download the repository and run it all locally from your device. Download the latest ZIP archive of the project, extract all contents to one folder, and open index.html to get started! Keep in mind that you'll need to update your local copy manually; it will not automatically update. Follow the same steps to update your local copy, replacing all files when prompted.

Credits

Ribbons.Guide was developed as a love letter to the helpful and welcoming r/PokémonRibbons community.

The images used in Ribbons.Guide were provided by:

Ribbons.Guide also makes use of the following dependencies:

License

Pokémon, data, and images © Nintendo/Creatures Inc./Game Freak. This project is not affiliated with Nintendo, Creatures Inc., Game Freak, or The Pokémon Company.

All original content and code is governed by the GPL-3.0 license.