Skip to content

Commit ebc8a19

Browse files
Using go install to expedite usage (#28)
* Update README.md * Update README.md
1 parent e91df2e commit ebc8a19

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

README.md

+7-19
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GPT-PullRequest-Updater
22

3+
[![go-recipes](https://raw.githubusercontent.com/nikolaydubina/go-recipes/main/badge.svg?raw=true)](https://github.com/nikolaydubina/go-recipes)
4+
35
This repository contains a tool for updating and reviewing GitHub pull requests using OpenAI's GPT language model. The project has two commands: `description` and `review`. The `description` command updates the pull request description with a high-level summary of the changes made. The `review` command creates individual comments for each file and an overall review summary comment.
46

57
## Requirements
@@ -9,24 +11,10 @@ This repository contains a tool for updating and reviewing GitHub pull requests
911

1012
## Installation
1113

12-
1. Clone the repository:
13-
14-
```
15-
git clone https://github.com/ravilushqa/gpt-pullrequest-updater.git
16-
```
17-
18-
2. Navigate to the project root:
19-
20-
```
21-
cd gpt-pullrequest-updater
22-
```
23-
24-
3. Build the commands:
25-
26-
```
27-
go build -o description ./cmd/description
28-
go build -o review ./cmd/review
29-
```
14+
```bash
15+
go install github.com/ravilushqa/gpt-pullrequest-updater/cmd/description@latest
16+
go install github.com/ravilushqa/gpt-pullrequest-updater/cmd/review@latest
17+
```
3018

3119
## Usage
3220

@@ -140,4 +128,4 @@ Select "Read and Write" permissions for the actions. This will provide your toke
140128
By following these steps, you'll grant the required permissions for the GPT-PullRequest-Updater GitHub Action to function properly, allowing it to update and review pull requests in your repository.
141129

142130
License
143-
This project is licensed under the MIT License.
131+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)