Skip to content

Commit

Permalink
[ENH] Enhance README with project details, usage instructions, and li…
Browse files Browse the repository at this point in the history
…cense information

* Add project title and description
* Include CI, PyPI version, Python version, and license badges
* Provide installation instructions using pip
* Explain usage of commitai command-line tool
  - Describe the purpose and functionality of commitai
  - Mention the supported AI language models (GPT-4 and Claude)
* Add sections for setting environment variables and creating custom templates
  - Provide examples for setting API keys and global commit template
  - Explain how to create a repository-specific template using the `create-template` command
* Include license information and link to the LICENSE file

Co-authored-by: Comai <github.com/lguibr/comai>
  • Loading branch information
lguibr committed Mar 9, 2024
1 parent 3638f1f commit c138b6a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# commitai - Commit Message AI
# 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)

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 Expand Up @@ -30,11 +35,6 @@ export TEMPLATE_COMMIT="My global custom template: {message}"

#### Creating a Template for the Repository

[![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)

You can create a custom template specific to the repository using the `create-template` command. This template will override the global template set in the `TEMPLATE_COMMIT` environment variable if present.

commitai create-template "My repository-specific template: {message}"
Expand Down

0 comments on commit c138b6a

Please sign in to comment.