Skip to content

Commit c93e697

Browse files
committed
update readme
1 parent c7edc76 commit c93e697

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# D&D Battle Tracker ⚔️
2+
![version badge](https://img.shields.io/github/package-json/v/jazzsequence/DnD-Battle-Tracker)
3+
24
A simple battle tracking system for Dungeons & Dragons written in JavaScript to track initiative and damage.
5+
6+
![Animated Demo](https://media.giphy.com/media/chb2RfSawhoj7KYyvb/giphy.gif)
7+
8+
## Description
9+
10+
I originally built this as an experiment after finishing [Wes Bos](https://github.com/wesbos)' [ES6 for Everyone](https://es6.io/) course to test my newfound JavaScript knowledge, put some of the things he talked about into practice, and to scratch my own itch; at the time I had just started running a D&D campaign for my kids.
11+
12+
After completing his [CSS Grid](https://cssgrid.io/) course, I decided to revisit this again to add some much-needed styling and layout.
13+
14+
Next up is integrating browser storage and possibly refactoring as a React app.
15+
16+
## Roadmap
17+
These are things I plan (or at least _hope_) to implement in the future.
18+
19+
* Use browser storage to retain party data after refresh
20+
* Allow encounters to be reset without losing data
21+
* Initiative randomizer (define initiative rather than entering rolled values)
22+
* Attack options (each character/monster has their attacks & damage listed so dealing damage can be done by just clicking the button next to that attack type)
23+
* Unit tests and linting
24+
* More?
25+
26+
## Changelog
27+
28+
### 0.2.0
29+
* added build tools
30+
* added styling and layout
31+
* some minor tweaks to initiative tracker and messages
32+
* expanded readme
33+
34+
### 0.1.0
35+
* Initial release

0 commit comments

Comments
 (0)