Add better readme

X-R-G-B · Sep 17, 2024 · 5ec54c2 · 5ec54c2
1 parent 7143341
commit 5ec54c2
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 0 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1 +1,3 @@
 .env
+.ruff_cache
+assets
diff --git a/.gitignore b/.gitignore
@@ -160,3 +160,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+/.ruff_cache
diff --git a/README.md b/README.md
@@ -4,6 +4,17 @@ Display what time is it for your friend in their timezone.
 
 ## Usage
 
+This bot use only slash command.
+
+![slash commands](./assets/images/slash_commands.png)
+
+Once you setup a channel for the world clock, WorldTimeZone Bot will send a
+message there, and update it every 5 minutes with current time.
+
+![world clock](./assets/images/world_clock.png)
+
+## Install
+
 ### Binary (linux only)
 
 1. Grab a binary for your platform in the latest release

diff --git a/assets/images/slash_commands.png b/assets/images/slash_commands.png
diff --git a/assets/images/world_clock.png b/assets/images/world_clock.png