docs: issue / pr template and readme updates

.github/ISSUES_TEMPLATE.md

@@ -5,10 +5,6 @@ this project (found in the CODE_OF_CONDUCT.md file).
 
 Please fill out this template with all the relevant information so we can
 understand what's going on and fix the issue.
-
-I'll probably ask you to submit the fix (after giving some direction). If you've
-never done that before, that's great! Check this free short video tutorial to
-learn how: http://kcd.im/pull-request
 -->
 
 - `thokr` version:

.github/PULL_REQUEST_TEMPLATE.md

@@ -31,11 +31,10 @@ merge of your pull request!
 
 <!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
 
-- [ ] Documentation
-- [ ] Tests
-- [ ] TypeScript Types
-- [ ] Flow Types
-- [ ] Ready to be merged
+- [x] Documentation added
+- [ ] Tests added
+- [ ] No linting errors / broken tests
+- [ ] Merge ready
       <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
 
 <!-- feel free to add additional comments -->

README.md

@@ -5,7 +5,8 @@
 <hr >
 
 [![License](https://img.shields.io/badge/License-MIT-default.svg)](.github/LICENSE.md)
-[![GitHub Build Workflow](https://img.shields.io/github/workflow/status/coloradocolby/thokr/build)](https://github.com/coloradocolby/thokr/issues)
+[![GitHub Build Workflow](https://github.com/coloradocolby/thokr/actions/workflows/build.yml/badge.svg)](https://github.com/coloradocolby/thokr/actions/workflows/build.yml)
+[![GitHub Docker Workflow](https://github.com/coloradocolby/thokr/actions/workflows/docker.yml/badge.svg)](https://github.com/coloradocolby/thokr/actions/workflows/docker.yml)
 [![GitHub Issues](https://img.shields.io/github/issues/coloradocolby/thokr)](https://github.com/coloradocolby/thokr/issues)
 
 ![demo](./assets/demo.gif)
@@ -48,11 +49,35 @@ The following languages are available by default:
 | `english1k`  |  1000 most common English words |
 | `english10k` | 10000 most common English words |
 
+## Roadmap
+
+- [ ] ⚡️ Performance
+  - Right now there are known performance issues surrounding the rendering of
+    the tui at each tick interval and/or key press. Ideally each render could
+    use the last render to make only minor adjustments (possibly using
+    [StatefulWidget](https://docs.rs/tui/0.10.0/tui/widgets/trait.StatefulWidget.html),
+    but I haven't been able to figure that out yet.
+- [ ] 🔠 Multi-language support
+  - I decided not to launch thokr with languages besides english because of some
+    odd rendering issues I was experiencing when trying to input characters with
+    accents. It's as though I'm not able to properly input the character in [raw
+    mode](https://docs.rs/crossterm/0.3.0/crossterm/raw/index.html). I'd love to
+    have that figure out before shipping other languages because I personally
+    felt the experience was a bit jarring. I'll open an bug report for it with
+    more details and replication steps -- would love more eyes on that problem!
+- [ ] 🧪 Tests
+  - I've only written a small amount of tests at this point. I haven't sat down
+    to really think through what tests look like when the output is dependent on
+    the users terminal size, font size, etc. If you have any ideas for this please
+    open up an issue and start the discussion!
+
 ## Contributing
 
 All contributions are **greatly appreciated**.
 
-If you have a suggestion that would make thokr better, please fork the repo and create a [pull request](https://github.com/coloradocolby/thokr/pulls). You can also simply open an issue and select `Feature Request`
+If you have a suggestion that would make thokr better, please fork the repo and
+create a [pull request](https://github.com/coloradocolby/thokr/pulls). You can
+also simply open an issue and select `Feature Request`
 
 1. Fork the repo
 2. Create your feature branch (`git checkout -b feature/xyz`)
@@ -61,15 +86,16 @@ If you have a suggestion that would make thokr better, please fork the repo and
 5. Push to your branch (`git push origin feature/xyz`)
 6. Fill out pull request template
 
-See the [open issues](https://github.com/coloradocolby/thokr/issues) for a full list of proposed features (and known issues).
+See the [open issues](https://github.com/coloradocolby/thokr/issues) for a full
+list of proposed features (and known issues).
 
 ## License
 
 Distributed under the MIT License. See [LICENSE.md](.github/LICENSE.md) for more information.
 
 ## Acknowledgments
 
-Check out these amazing projects that helped inspire thokr!
+Check out these amazing projects that inspired thokr!
 
 - [monkeytype](https://github.com/Miodec/monkeytype)
 - [tui-rs](https://github.com/fdehau/tui-rs)