Merge pull request #10 from funkyFangs/update-readme

📝 update README.md

README.md

@@ -1,38 +1,68 @@
-# create-svelte
+# Shiny Hunter
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+Shiny Hunter is a progressive web application built for hunting shiny Pokémon. This project is maintained out of personal interest, and new features/fixes will be delivered whenever I see fit. However, please feel free to make feature requests or report issues!
 
-## Creating a project
+# Features
 
-If you're seeing this, you've probably already done this step. Congrats!
+## Tabbed Interface
 
-```bash
-# create a new project in the current directory
-npm create svelte@latest
+At its core, Shiny Hunter provides an easy way to keep track of multiple shiny hunts. The main page features a tabbed interface where users can switch between different shiny hunts.
 
-# create a new project in my-app
-npm create svelte@latest my-app
-```
+<img src="assets/tabs.png" alt="A screenshot of the tabs in Shiny Hunter" width="250px"/>
 
-## Developing
+## Specify Hunt Details
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Shiny Hunter is built to hunt for a wide array of Pokémon and provides a high level of specificity for what you're hunting, including different varieties, forms, and genders.
 
-```bash
-npm run dev
+<img src="assets/creation.png" alt="A screenshot of shiny hunt creation menu" width="250px"/>
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
+## Tailored Controls
 
-## Building
+The many different ways to hunt shiny Pokémon requires a different way to keep track of a shiny hunt between each method.
+Shiny Hunter provides controls tailored to each method in order to provide useful and accurate data of your shiny hunt.
 
-To create a production version of your app:
+<img src="assets/odds.png" alt="A screenshot of the controls for a consecutive fishing shiny hunt" width="250px"/>
 
-```bash
-npm run build
-```
+## Customizable Visuals
 
-You can preview the production build with `npm run preview`.
+Shiny Hunter provides a couple of options to customize what sprites you see while hunting for shiny Pokémon.
 
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+### Sprite Sources
+
+The application can display of one of three different sources for the sprite of the Pokémon you're hunting:
+
+1. The original sprite from that generation
+
+<img src="assets/generation.png" alt="A screenshot of the HeartGold shiny sprite for Totodile" width="250px"/>
+
+2. The model used for Pokémon Showdown
+
+<img src="assets/showdown.png" alt="A screenshot of the Pokémon Showdown shiny sprite for Totodile" width="250px"/>
+
+3. The image used for Pokémon home
+
+<img src="assets/home.png" alt="A screenshot of the Pokémon Home shiny sprite for Totodile" width="250px"/>
+
+### Normal Sprites
+
+Some shiny Pokémon may be hard to distinguish from their normal counterparts. In this case, you can enable "Show Normal Sprites" to view a side-by-side comparison of the shiny sprite and normal sprite.
+
+<img src="assets/show-normal.png" alt="A screenshot of the shiny and normal sprites for Totodile in Shiny Hunter" width="250px"/>
+
+## Hunt History
+
+Shiny Hunter keeps track of previously completed shiny hunts that you can view at any time.
+
+<img src="assets/history.png" alt="A screenshot of history page with a previous shiny hunt selected" width="250px"/>
+
+## Full Application
+
+As a progressive web application, Shiny Hunter provides many of the same benefits as a native application for mobile devices and web browsers alike.
+
+1. Shiny Hunter can be installed from your web browser as a native application on your mobile device
+2. Shiny Hunter will continue to work if you go offline
+3. No accounts are needed to use this service, as all data is stored locally in your device's browser
+
+## Accessibility
+
+A large amount of effort was put into making Shiny Hunter as accessible as possible; in particular, full keyboard navigation is supported using the industry standards for design and functionality.