From 2fd1253d805cea9e184f3aaf61e2b0b2530c5dd4 Mon Sep 17 00:00:00 2001
From: ruru <142723369+ruru-m07@users.noreply.github.com>
Date: Sat, 11 May 2024 14:47:05 +0530
Subject: [PATCH] docs(readme): create initial readme file.

---
 README.md    | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 app/page.tsx |  2 +-
 2 files changed, 48 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e69de29..96202f1 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,47 @@
+<div style="text-align: center;">
+    <img src="/public/og.png" alt="og" />
+</div>
+
+## 🌟 Commitly (Web): The Ultimate Git Commit Message Assistant.
+
+- This web app helps you write informative and engaging git commit messages by providing suggestions based on your code changes.
+
+## ✨ Features and Benefits:
+
+- 🚀 Provides suggestions based on your code changes
+- 📝 Helps you write clear and concise commit messages
+- 📈 Improves the quality of your git history
+- ⏰ Saves you time and effort
+
+## How to Use Commitly
+
+1. Visit the [Commitly](https://commitly.vercel.app/) website.
+2. Paste your code changes into the text box.
+3. Click the `Generate` button.
+
+> ![image](https://github.com/ruru-m07/commitly/assets/142723369/f4c8c94b-42c7-4a53-89a1-27542f90e47c)
+
+4. Commitly will analyze your code changes and suggest a commit message.
+5. You can edit the suggested message or use it as is.
+6. Click the "Copy to Clipboard" button to copy the commit message.
+
+> ![image](https://github.com/ruru-m07/commitly/assets/142723369/a2e13ef0-3ad3-4760-8af8-5cff56c538d7)
+
+## ☘️ Contributing:
+
+- Contributions are welcome! 💖 Please read the [contributing guidelines](https://github.com/ruru-m07/commitly/blob/issue-13/CONTRIBUTING.md) before submitting a pull request.
+
+## 🚀 Getting Started for Developers:
+
+- Clone the repository: `git clone https://github.com/ruru-m07/commitly.git`
+- Install the dependencies: `pnpm install`
+- Set up `.env` file.
+- Run the development server: `pnpm dev`
+
+## ✅ License:
+
+- [MIT](https://github.com/ruru-m07/commitly/blob/issue-13/LICENSE)
+
+## 😆 Feedback:
+
+- Your feedback is valuable to us. Please share your thoughts and suggestions on how we can make Commitly better.
diff --git a/app/page.tsx b/app/page.tsx
index bc7cd38..2e95c38 100644
--- a/app/page.tsx
+++ b/app/page.tsx
@@ -149,7 +149,7 @@ export default function Home() {
                 disabled={isLoading}
               >
                 {isLoading && <Spinner className="size-4" />}
-                Send Message
+                  Generate
                 <CornerDownLeft className="size-3.5" />
               </Button>
             </div>