doc updates

.github/CODE_OF_CONDUCT.md

@@ -67,7 +67,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting me directly at coloradocolby@gmail.com. All complaints
+reported by contacting me directly at thatvegandev@gmail.com. All complaints
 will be reviewed and investigated and will result in a response that is deemed
 necessary and appropriate to the circumstances. The project team is obligated
 to maintain confidentiality with regard to the reporter of an incident. Further

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,7 +26,7 @@ merge of your pull request!
 <!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
 
 - [ ] `Allow edits from maintainers` option checked
-- [ ] Branch name is prefixed with `[your_username]/` (ex. `coloradocolby/featureX`)
+- [ ] Branch name is prefixed with `[your_username]/` (ex. `thatvegandev/featureX`)
 - [ ] Documentation added
 - [ ] Tests added
 - [ ] No failing actions

.github/workflows/deploy.yml

@@ -21,7 +21,7 @@ jobs:
         id: meta
         uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
         with:
-          images: coloradocolby/thokr
+          images: thatvegandev/thokr
 
       - name: build and push docker image
         uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc

Cargo.toml

@@ -1,14 +1,14 @@
 [package]
 name = "thokr"
-description = "a sleek typing tui written in rust"
-version = "0.4.0"
+description = "sleek typing tui with visualized results and historical logging"
+version = "0.4.1"
 readme = "README.md"
-repository = "https://github.com/coloradocolby/thokr.git"
-homepage = "https://github.com/coloradocolby/thokr"
+repository = "https://github.com/thatvegandev/thokr.git"
+homepage = "https://github.com/thatvegandev/thokr"
 license = "MIT"
-authors = ["Colby Thomas <coloradocolby@gmail.com>"]
+authors = ["Colby Thomas <thatvegandev@gmail.com>"]
 edition = "2021"
-exclude = ["assets/*", ".github", "*.log", "Dockerfile"]
+exclude = [".github", "*.log", "Dockerfile"]
 keywords = ["tui", "terminal", "typing"]
 
 [dependencies]

README.md

@@ -1,13 +1,50 @@
 # thokr
-✨ sleek typing tui written in rust
+✨ sleek typing tui with visualized results and historical logging
 
-[![GitHub Build Workflow](https://github.com/coloradocolby/thokr/actions/workflows/build.yml/badge.svg)](https://github.com/coloradocolby/thokr/actions/workflows/build.yml)
-[![GitHub Deploy Workflow](https://github.com/coloradocolby/thokr/actions/workflows/deploy.yml/badge.svg)](https://github.com/coloradocolby/thokr/actions/workflows/deploy.yml)
+[![GitHub Build Workflow](https://github.com/thatvegandev/thokr/actions/workflows/build.yml/badge.svg)](https://github.com/thatvegandev/thokr/actions/workflows/build.yml)
+[![GitHub Deploy Workflow](https://github.com/thatvegandev/thokr/actions/workflows/deploy.yml/badge.svg)](https://github.com/thatvegandev/thokr/actions/workflows/deploy.yml)
 [![License](https://img.shields.io/badge/License-MIT-default.svg)](./LICENSE.md)
 [![Crate Version](https://img.shields.io/crates/v/thokr)](https://crates.io/crates/thokr)
-[![Github Stars](https://img.shields.io/github/stars/coloradocolby/thokr)](https://github.com/coloradocolby/thokr/stargazers)
+[![Github Stars](https://img.shields.io/github/stars/thatvegandev/thokr)](https://github.com/thatvegandev/thokr/stargazers)
+
+![demo](https://github.com/thatvegandev/assets/raw/main/thokr/demo.gif)
+
+## Usage
+
+For detailed usage run `thokr -h`.
+
+```
+thokr 0.4.1
+sleek typing tui with visualized results and historical logging
+
+USAGE:
+    thokr [OPTIONS]
+
+OPTIONS:
+    -f, --full-sentences <NUMBER_OF_SENTENCES>
+            number of sentences to use in test
+
+    -h, --help
+            Print help information
+
+    -l, --supported-language <SUPPORTED_LANGUAGE>
+            language to pull words from [default: english] [possible values: english, english1k,
+            english10k]
+
+    -p, --prompt <PROMPT>
+            custom prompt to use
+
+    -s, --number-of-secs <NUMBER_OF_SECS>
+            number of seconds to run test
+
+    -V, --version
+            Print version information
+
+    -w, --number-of-words <NUMBER_OF_WORDS>
+            number of words to use in test [default: 15]
+
+```
 
-![demo](./assets/demo.gif)
 
 ## Installation
 
@@ -20,7 +57,7 @@ $ cargo install thokr
 ### Docker
 
 ```sh
-$ docker run -it coloradocolby/thokr
+$ docker run -it thatvegandev/thokr
 ```
 
 ### Arch Linux
@@ -95,7 +132,7 @@ can easily track your progress over time.
 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
+create a [pull request](https://github.com/thatvegandev/thokr/pulls). You can
 also simply open an issue and select `Feature Request`
 
 1. Fork the repo
@@ -105,7 +142,7 @@ also simply open an issue and select `Feature Request`
 5. Push to your branch (`git push origin [your_username]/xyz`)
 6. Fill out pull request template
 
-See the [open issues](https://github.com/coloradocolby/thokr/issues) for a full
+See the [open issues](https://github.com/thatvegandev/thokr/issues) for a full
 list of proposed features (and known issues).
 
 ## License
@@ -123,8 +160,6 @@ Check out these amazing projects that inspired thokr!
 
 ## Follow
 
-[![github](https://img.shields.io/github/followers/coloradocolby?style=social)](https://github.com/coloradocolby)
-
-[![twitter](https://img.shields.io/twitter/follow/coloradocolby?color=white&style=social)](https://twitter.com/coloradocolby)
-
-[![youtube](https://img.shields.io/youtube/channel/subscribers/UCEDfokz6igeN4bX7Whq49-g?style=social)](https://youtube.com/user/coloradocolby)
+[![github](https://img.shields.io/github/followers/thatvegandev?style=social)](https://github.com/thatvegandev)
+[![twitter](https://img.shields.io/twitter/follow/thatvegandev?color=white&style=social)](https://twitter.com/thatvegandev)
+[![youtube](https://img.shields.io/youtube/channel/subscribers/UCEDfokz6igeN4bX7Whq49-g?style=social)](https://youtube.com/user/thatvegandev)

src/main.rs

@@ -26,7 +26,7 @@ use webbrowser::Browser;
 
 const TICK_RATE_MS: u64 = 100;
 
-/// a sleek typing tui written in rust
+/// sleek typing tui with visualized results and historical logging
 #[derive(Parser, Debug, Clone)]
 #[clap(version, about, long_about= None)]
 pub struct Cli {
@@ -231,7 +231,7 @@ fn start_tui<B: Backend>(
                                 true => match key.code {
                                     KeyCode::Char('t') => {
                                         if Browser::is_available() {
-                                            webbrowser::open(&format!("https://twitter.com/intent/tweet?text={}%20wpm%20%2F%20{}%25%20acc%20%2F%20{:.2}%20sd%0A%0Ahttps%3A%2F%2Fgithub.com%2Fcoloradocolby%2Fthokr", app.thok.wpm, app.thok.accuracy, app.thok.std_dev))
+                                            webbrowser::open(&format!("https://twitter.com/intent/tweet?text={}%20wpm%20%2F%20{}%25%20acc%20%2F%20{:.2}%20sd%0A%0Ahttps%3A%2F%2Fgithub.com%thatvegandev%2Fthokr", app.thok.wpm, app.thok.accuracy, app.thok.std_dev))
                                     .unwrap_or_default();
                                         }
                                     }