Skip to content

Commit

Permalink
[ENH] Improve README with updated project name, badges, and description
Browse files Browse the repository at this point in the history
* Update project name from "comai" to "CommitAi"
  - Rename references to "comai" with "CommitAi" in the README
* Update PyPI and license badges to use the new project name
  - Ensure the badges point to the correct PyPI package and license file
* Enhance the project description
  - Provide a more detailed explanation of the tool's purpose and functionality
  - Mention the supported AI language models (GPT-4 and Claude)
  - Highlight the ability to analyze staged changes and combine them with user-provided explanations
  - Mention the support for custom commit message templates and the back command for resetting to previous commits
  - Emphasize the benefits of using CommitAi, such as saving time, ensuring consistency, and maintaining a meaningful commit history

This enhancement improves the README file by updating the project name, badges, and providing a more comprehensive description of CommitAi. The updated README better communicates the tool's features, supported AI models, and benefits to potential users, making it easier for them to understand the project's purpose and value.

Co-authored-by: Comai <github.com/lguibr/comai>
  • Loading branch information
lguibr committed Mar 9, 2024
1 parent 93856da commit 971623d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# CommitAi - Commit Message AI

[![CI](https://github.com/lguibr/comai/workflows/CI/badge.svg)](https://github.com/lguibr/comai/actions)
[![PyPI](https://img.shields.io/pypi/v/comai.svg)](https://pypi.org/project/comai/)
[![Python Version](https://img.shields.io/pypi/pyversions/comai.svg)](https://pypi.org/project/comai/)
[![License](https://img.shields.io/pypi/l/comai.svg)](https://github.com/lguibr/comai/blob/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/CommitAi.svg)](https://pypi.org/project/CommitAi/)
[![Python Version](https://img.shields.io/pypi/pyversions/CommitAi.svg)](https://pypi.org/project/CommitAi/)
[![License](https://img.shields.io/pypi/l/comai.svg)](https://github.com/lguibr/CommitAi/blob/main/LICENSE)

commitai is a command-line tool that helps you generate informative and relevant commit messages for your Git repositories using AI language models like GPT-4 and Claude. It analyzes your staged changes, combines them with a high-level explanation provided by you, and creates a commit message based on this information. Additionally, it supports custom commit message templates and a back command to reset to previous commits. This not only saves you time and effort but also ensures a consistent and meaningful commit history.

Expand Down

0 comments on commit 971623d

Please sign in to comment.