docs: 📚 update the readme

Status: done
Tomelin · Oct 3, 2024 · 00212b1 · 00212b1
1 parent f4b4059
commit 00212b1
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 22 deletions.
diff --git a/.assets/imgs/demo.gif b/.assets/imgs/demo.gif
diff --git a/.assets/imgs/result.png b/.assets/imgs/result.png
diff --git a/README.md b/README.md
@@ -38,30 +38,11 @@ gcommit --commit "feat: add new feature"
 
 ## Example
 Here is an example of how to use **gCommit** in interactive mode:
+![Demo to commit](./.assets/imgs/demo.gif)
 
-```
-$ gcommit --interactive
-Select kind of commit:
-  1. feat
-  2. fix
-  3. chore
-  4. docs
-  5. style
-  6. refactor
-  7. perf
-  8. test
-> 1
-
-Write the task id:
-> 12345
-
-Enable emoji in commit message? (y/n):
-> y
-
-Commit Message:
-> Add new feature for user authentication
+**Result of the commit**
+![Result to commit](./.assets/imgs/result.png)
 
-```
 You chose ```feat: :sparkles: Add new feature for user authentication"```
 
 Contributing