FEA (Documentation): Add CommitAi demo GIF to README

* Include a demo GIF showcasing the usage and functionality of CommitAi * Update the README to display the GIF, providing visual context for potential users * Optimize the GIF file to ensure efficient loading and display within the README By adding a demo GIF to the README, users can quickly grasp the core features and workflow of CommitAi, making it easier for them to understand its value and decide whether to incorporate it into their development process.
lguibr · Apr 25, 2024 · 9750b33 · 9750b33
1 parent fc803f1
commit 9750b33
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@
 
 **CommitAi** simplifies the Git commit message creation process by leveraging AI technologies, including GPT-4 and Claude. Designed for developers who value clarity and precision in commit histories, **CommitAi** offers a streamlined workflow that transforms your staged changes and high-level explanations into informative commit messages. Enhance your project documentation and streamline your development process with commit messages that truly reflect your changes.
 
+![CommitAi Demo](./assets/commitaai.gif)
+
 ## Features
 
 - **Intelligent Commit Generation**: Leverages state-of-the-art AI models to generate meaningful commit messages from your changes.

diff --git a/assets/commitaai.gif b/assets/commitaai.gif