Update README.md
parent
b5f8756be3
commit
d710797570
@ -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
|
||||
<p align="center"><a href="https://turnipprophet.io" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/mikebryant/ac-nh-turnip-prices/master/img/favicon-128.png" alt="Turnip Prophet logo"></a></p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/bRh74X8" target="_blank"><img src="https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=for-the-badge" /></a>
|
||||
<a href="https://github.com/mikebryant/ac-nh-turnip-prices/issues" target="_blank"><img src="https://img.shields.io/github/issues/mikebryant/ac-nh-turnip-prices?style=for-the-badge" /></a>
|
||||
<a href="https://github.com/mikebryant/ac-nh-turnip-prices/pulls" target="_blank"><img src="https://img.shields.io/github/issues-pr/mikebryant/ac-nh-turnip-prices?style=for-the-badge" /></a>
|
||||
<a href="https://github.com/mikebryant/ac-nh-turnip-prices/graphs/contributors" target="_blank"><img src="https://img.shields.io/github/contributors/mikebryant/ac-nh-turnip-prices?style=for-the-badge" /></a>
|
||||
</p>
|
||||
|
||||
# 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:
|
||||
|
||||
<table width="100%">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Turnip Prophet is for</th>
|
||||
<th>Turnip Prophet is <u>not</u> for</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>A predictor for future prices that week</li>
|
||||
<li>Able to calculate probabilities for different futures</li>
|
||||
<li>Able to show data from a query string</li>
|
||||
<li>A single page web-based app</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>A calculator for how much money you'll make</li>
|
||||
<li>A way to count your turnips</li>
|
||||
<li>A way to store multiple people's islands</li>
|
||||
<li>Something with a backend</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
If your idea, suggestment or improvement is anything out of the above named, feel free to [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues) or contribute by a [new pull request](https://github.com/mikebryant/ac-nh-turnip-prices/pulls).
|
||||
|
||||
### Final statement
|
||||
|
||||
A special thanks to all who [contribute](https://github.com/mikebryant/ac-nh-turnip-prices/graphs/contributors) to this project, helping improve it and spend their time.
|
||||
|
||||
Stay awesome guys.
|
Loading…
Reference in New Issue