Skip to content

Commit fb49108

Browse files
committed
docs(readme): documentation reference.
- Add Codecov and Go Report Card badges to README.md - Add cover.png image to images folder - Add an OpenAI Chat completions documentation reference
1 parent d32c3bb commit fb49108

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# CodeGPT
22

33
[![Lint and Testing](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml)
4+
[![codecov](https://codecov.io/gh/appleboy/CodeGPT/branch/main/graph/badge.svg)](https://codecov.io/gh/appleboy/CodeGPT)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/CodeGPT)](https://goreportcard.com/report/github.com/appleboy/CodeGPT)
46

5-
A [git prepare-commit-msg hook](https://git-scm.com/docs/githooks) using ChatGPT written in [Golang](https://go.dev).
7+
![cover](./images/cover.png)
8+
9+
A CLI written in [Golang](https://go.dev) that writes your git commit messages for you with ChatGPT AI (`gpt-3.5-turbo` model) and install a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks) automatically.
10+
11+
## Installation
12+
13+
## Reference
14+
15+
* [OpenAI Chat completions documentation](https://platform.openai.com/docs/guides/chat).

images/cover.png

49.6 KB
Loading

0 commit comments

Comments
 (0)