From f58a40d57e894f7e49b196bceb16be2c0460605a Mon Sep 17 00:00:00 2001
From: Mroik <mroik@delayed.space>
Date: Sun, 2 Feb 2025 05:12:17 +0100
Subject: Add example to README

---
 Cargo.lock         |  20 ++++++++++----------
 Cargo.toml         |   4 ++--
 README.md          |  14 ++++++++++++--
 assets/example.gif | Bin 0 -> 2416287 bytes
 4 files changed, 24 insertions(+), 14 deletions(-)
 create mode 100644 assets/example.gif

diff --git a/Cargo.lock b/Cargo.lock
index 4cd9f09..4f263c7 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -244,6 +244,16 @@ version = "0.4.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "04cbf5b083de1c7e0222a7a51dbfdba1cbe1c6ab0b15e29fff3f6c077fd9cd9f"
 
+[[package]]
+name = "marika-finger-blaster"
+version = "0.0.1"
+dependencies = [
+ "clap",
+ "crossterm",
+ "rand",
+ "tokio",
+]
+
 [[package]]
 name = "memchr"
 version = "2.7.4"
@@ -481,16 +491,6 @@ dependencies = [
  "syn",
 ]
 
-[[package]]
-name = "typer"
-version = "0.1.0"
-dependencies = [
- "clap",
- "crossterm",
- "rand",
- "tokio",
-]
-
 [[package]]
 name = "unicode-ident"
 version = "1.0.14"
diff --git a/Cargo.toml b/Cargo.toml
index d24b637..f0fcc2b 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "typer"
-version = "0.1.0"
+name = "marika-finger-blaster"
+version = "0.0.1"
 edition = "2021"
 
 [dependencies]
diff --git a/README.md b/README.md
index 329ac85..05d7f6c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,12 @@
-A typing program kinda like monkeytype.com but in your terminal! Just run it
-specifying the text to use with `--quote`.
+# Marika Finger Blaster
+A typing program kinda like monkeytype.com but in your terminal! 
+There's only one argument you have to use which is the path to a file containing
+the text you want to use.
+![gif showing how it works](https://raw.githubusercontent.com/Mroik/marika-finger-blaster/refs/heads/master/assets/example.gif)
+
+At the end it shows your:
+- WPM
+- Amount of mistakes
+- Accuracy.
+It even has a mistake history highlighting where were your mistakes. 
+(Sorry for the font of my terminal :P)
diff --git a/assets/example.gif b/assets/example.gif
new file mode 100644
index 0000000..2f66076
Binary files /dev/null and b/assets/example.gif differ
-- 
cgit v1.3