docs(README.md): add screenshots section with example image to enhanc…

…e visual understanding of the project
rtuszik · Oct 11, 2024 · a8e1dec · a8e1dec
1 parent 522236c
commit a8e1dec
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,12 @@ KoalaKeys helps generate and organize interactive HTML cheatsheets for keyboard
 
 > **Quick Start**: To create a cheatsheet, add a YAML file to the `cheatsheets` directory and run `python src/generate_cheatsheet.py`. For detailed YAML formatting instructions, see the [YAML Cheatsheet Specification Guide](https://github.com/rtuszik/KoalaKeys/blob/cc427d1ee6fcc8a6f671954848b161c8f1bff599/yaml_cheatsheet_spec.md).
 
+## Screenshots
+
+<p align="center">
+  <img src="assets/images/KoalaKeys_Example.png">
+</p>
+
 ## Features
 
 - Generate HTML cheatsheets from YAML files

diff --git a/assets/images/KoalaKeys_Example.png b/assets/images/KoalaKeys_Example.png