Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down