Skip to content

Commit 03c71c3

Browse files
authored
Revise README for improved descriptions and features
Updated README to enhance clarity and add features.
1 parent 5e0d4ed commit 03c71c3

1 file changed

Lines changed: 8 additions & 13 deletions

File tree

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
11
<div align="center">
2+
<img width="716" height="94" alt="commitcat" src="https://github.com/user-attachments/assets/ae050994-6d3c-42af-b272-1bda53bfd4a2" />
23

3-
<!-- prettier-ignore -->
4-
```text
5-
▄█████ ▄████▄ ██▄ ▄██ ██▄ ▄██ ██ ██████ ▄█████ ▄████▄ ██████
6-
██ ██ ██ ██ ▀▀ ██ ██ ▀▀ ██ ██ ██ ▄▄▄ ██ ██▄▄██ ██
7-
▀█████ ▀████▀ ██ ██ ██ ██ ██ ██ ▀█████ ██ ██ ██
8-
```
94

105
**"고민은 개발만 늦출 뿐, 커밋 메시지 고민은 Commit-cat에게 맡기세요."**
116

127
[![version](https://img.shields.io/badge/version-0.3.0-blue.svg)](package.json)
138
[![license](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
149
[![node](https://img.shields.io/badge/node-%3E%3D18.0.0-orange.svg)](https://nodejs.org)
1510

16-
`commit-cat`**Gemini AI**를 활용하여 Git Stage에 올라온 변경 사항을 분석하고,<br/>가장 적절한 커밋 메시지를 제안하는 스마트한 CLI 도구입니다.
11+
`commit-cat`**Gemini AI**를 활용하여 Git Stage에 올라온 변경 사항을 분석하고,<br/>가장 적절한 커밋 메시지를 제안, 간단한 코드리뷰를 해줍니다.
1712

1813
[English](#-usage-en) | [한국어](#-usage-ko)
1914

2015
</div>
2116

2217
---
2318

24-
## Features
19+
## 핵심 기능
2520

26-
- Google Gemini API를 통해 소스 코드의 문맥을 이해하고 커밋 메시지 생성해요.
21+
- Google Gemini API를 통해 소스 코드의 문맥을 이해하고 커밋 메시지를 생성해요.
2722
- 변경된 파일과 라인 정보를 정밀하게 분석하여 요약해요.
2823
- 개선점이나 취약점이 보이면 알려줘요.
2924
- 가벼운 모델을 사용해 5초 내에 응답을 받을 수 있어요.
3025

3126
---
3227

33-
## Installation
28+
## 설치
3429

3530
```bash
3631
# Clone the repository
@@ -45,7 +40,7 @@ npm link
4540

4641
---
4742

48-
## Configuration
43+
## 설정
4944

5045
루트 디렉토리에 `.env` 파일을 생성하고 Gemini API 키를 설정하세요.
5146

@@ -55,7 +50,7 @@ GEMINI_API_KEY=your_google_gemini_api_key_here
5550

5651
---
5752

58-
## Usage (KO)
53+
## 사용법
5954

6055
가장 빈번하게 사용되는 명령어입니다.
6156

@@ -73,7 +68,7 @@ commit-cat -k
7368

7469
---
7570

76-
## Usage (EN)
71+
## Usage
7772

7873
```bash
7974
# Default execution (Suggests English messages)

0 commit comments

Comments
 (0)