diff --git a/README.md b/README.md index f478271..1c2fc45 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,67 @@ -# ac-nh-turnip-prices -[![discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/bRh74X8) - -Price calculator/predictor for Turnip prices -## Scope - -This tool is: -- A predictor for future prices that week -- Able to calculate probabilities for different futures -- Able to show data from a query string -- A single page web-based app - -This tool is not: -- A calculator for how much money you'll make -- A way to count your turnips -- A way to store multiple people's islands -- Something with a backend +
+ + + +# Animal Crossing: Turnip Prophet + +Turnip Prophet is a price calculator/price predictor for Animal Crossing turnip prices. + +### Support + +If you have any questions feel free to join our Discord server ([discord.gg/bRh74X8](https://discord.gg/bRh74X8)) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). + +Before opening a new issue, we would appreciate it if you would briefly use the search to avoid duplicate questions, because every duplicate question causes other functions to wait ;-) + +Please create issues in English language only. + +### Adding a new language + +Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a language file for it (requires basic git and development skills). + +For details don't hesitate to talk to us, e.g. using our Discord server. + +### What's about feature X? + +At first please have a look at our current project scope: + +Turnip Prophet is for | +Turnip Prophet is not for | +
---|---|
+
|
+
+
|
+