add readme

This commit is contained in:
insects 2025-02-06 15:19:38 +01:00
parent 90fadda0be
commit c0e8081a19

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# beacon
This is a small website providing a tracker for big fish in Final Fantasy XIV.
It's built with [axum](https://lib.rs/axum), [maud](https://maud.lambda.xyz), and Postgres as a datastore.
The data for fish is based on the data used in [Carbuncle Plushy's Fish Tracker](https://ff14fish.carbuncleplushy.com).
## Todo
Current major missing features include:
- [ ] Fisher's Intution (catching other fish to spawn a big fish)
- [ ] Spearfishing
- [ ] Better condition display, show the weather, etc
- [ ] Folklore requirement display
- [ ] Ability to remove caught fish (un-catch them)