update readme with animation gif

semihbkgr · Feb 11, 2024 · 628fff2 · 628fff2
1 parent 5ec2b8c
commit 628fff2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,12 @@
 # sorting-visualizer
 
 `sorting-visualizer` is a CLI tool that visually displays iterations in sorting algorithms.
+
+![animate](assets/output.gif)
+
+| Key     | Function                         |
+| ------- | -------------------------------- |
+| `space` | Toggle play/pause                |
+| `→`     | Forward to the next iteration    |
+| `←`     | Rewind to the previous iteration |
+| `m`     | Mute or unmute the beep sound    |
diff --git a/assets/output.gif b/assets/output.gif
diff --git a/src/main.rs b/src/main.rs
@@ -14,7 +14,7 @@ use sorting_visualizer::{
     sorting::{get_algorithm_func, get_algorithms, AlgorithmContext, Operation},
 };
 use std::{
-    fmt::{Debug, Display},
+    fmt::Display,
     io::{self, stdout},
     ops::{DerefMut, Index},
     sync::{Arc, Mutex},