docs: add screenshots of the tool

MAIF · Feb 6, 2025 · 0d7107b · 0d7107b
1 parent b759217
commit 0d7107b
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -104,3 +104,26 @@ yozf -c localhost
  - [Keybindings.](https://github.com/MAIF/yozefu/tree/main/docs/keybindings/README.md)
  - [Releasing a new version.](https://github.com/MAIF/yozefu/tree/main/docs/release/README.md)
 
+
+
+## Screenshots
+
+<table>
+  <tr>
+    <td>
+      <img alt="A table listing topics and kafka records" src="./docs/screenshots/topics.png">
+    </td>
+    <td>
+      <img alt="A table listing kafka records" src="./docs/screenshots/records.png">
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <img alt="View of a selected kafka records" src="./docs/screenshots/record.png">
+    </td>
+    <td>
+      <img alt="View of the help page" src="./docs/screenshots/help.png">
+    </td>
+  </tr>
+</table>
+
diff --git a/docs/screenshots/help.png b/docs/screenshots/help.png
diff --git a/docs/screenshots/record.png b/docs/screenshots/record.png
diff --git a/docs/screenshots/records.png b/docs/screenshots/records.png
diff --git a/docs/screenshots/topics.png b/docs/screenshots/topics.png