Update README
This commit is contained in:
parent
cad04690ff
commit
ab3281b288
1 changed files with 25 additions and 2 deletions
27
README.md
27
README.md
|
|
@ -1,2 +1,25 @@
|
||||||
# Foundry-Stat-Tracker
|
# Stats Tracker
|
||||||
A Foundry module that allows tracking arbitrary stats.
|
This FoundryVTT module aims to provide a clean way of keeping track of any data
|
||||||
|
points you want within Foundry, whether that be dice rolls, or other things like
|
||||||
|
how many natural 1s to natural 20s you get.
|
||||||
|
|
||||||
|
I was inspired by the dicestats module, however it only allows tracking dice
|
||||||
|
statistics, which is something I found myself needing to work around and struggle
|
||||||
|
against, so I decided to make this module to fill that gap while improving upon
|
||||||
|
the graph rendering.
|
||||||
|
|
||||||
|
For more information on how to use this module, check out the "Documentation"
|
||||||
|
compendium within your world!
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
You can find a history of all releases on the [Foundry package listing](https://foundryvtt.com/packages/stat-tracker)
|
||||||
|
or in the [GitHub releases tab](https://github.com/Oliver-Akins/Foundry-Stat-Tracker/releases).
|
||||||
|
Prereleases will only be released to the GitHub page, so if you want to check
|
||||||
|
out those releases, you'll need to use those manifest links directly.
|
||||||
|
|
||||||
|
## Bugs or Feature Requests
|
||||||
|
Bugs and Feature Requests can be submitted via the [GitHub issues](https://github.com/Oliver-Akins/Foundry-Stat-Tracker/issues/new/choose).
|
||||||
|
Planned features can also be seen in the GitHub issues list.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
Contribution guidelines / requirements coming soon.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue