Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit 09391cb

Browse files
committed
Update README with setup instructions and usage examples
1 parent b421e23 commit 09391cb

File tree

1 file changed

+17
-33
lines changed

1 file changed

+17
-33
lines changed

README.md

Lines changed: 17 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,28 @@ AICodeBot is a coding assistant designed to make your coding life easier. With c
66

77
⚠️ Status: This project is in its infancy with very limited features. Right now it only generates commit messages for you, but you can look at the Features list below to get an idea of where it is going. Give the project a star and follow along while we build out more of the foundation.
88

9-
## MVP
10-
11-
For the initial release, you can get a Fun Fact related to AI and Programming.
9+
## Setup and Usage
1210

13-
`aicodebot fun-fact`
11+
Follow the steps below to set up AICodeBot on your machine:
1412

15-
>>🤖 The first chess program written in Fortran for the IBM 704 computer in 1960 was beaten by a human in just four moves. The program relied heavily on brute force calculation, and had not yet developed sophisticated artificial intelligence algorithms.
13+
`pip install aicodebot`
1614

17-
Behind the scenes, this is talking to the Open AI API and getting a response via Langchain.
15+
The first time you run it, you'll be prompted to enter your OpenAI API key, which is required. You can get one for free on your [API key settings](https://platform.openai.com/account/api-keys").
1816

19-
#### Commit Message
17+
```bash
18+
> aicodebot --help
19+
Usage: aicodebot [OPTIONS] COMMAND [ARGS]...
2020

21-
Automate your commits by having aicodebot generate a commit message for you.
21+
Options:
22+
-V, --version Show the version and exit.
23+
-h, --help Show this message and exit.
2224

23-
`aicodebot commit`
25+
Commands:
26+
alignment Get a message about Heart-Centered AI Alignment ❤ + 🤖.
27+
commit Generate a git commit message and commit changes after you...
28+
fun-fact Tell me something interesting about programming or AI.
29+
version Print the version number.
30+
```
2431

2532
## Features
2633

@@ -62,32 +69,10 @@ Automate your commits by having aicodebot generate a commit message for you.
6269
- [X] **Alignment**: Gives a heart-centered inspirational message about how we can build AI in a way that aligns with humanity.
6370
- [ ] **Telling Jokes**: Tells programming jokes. :smiley:
6471
- [ ] **Supportive Encouragement**: High fives and kudos for a job well done
65-
- [ ] **Gif Reactions**: Reacts to messages with relevant and fun gifs. It could also react to specific events in the repository, like the merging of a pull request or the closing of an issue.
72+
- [ ] **GIF Reactions**: Reacts to messages with relevant and fun gifs. We've gotta figure out how to teach LLMs about humor.
6673

6774
<img src="https://camo.githubusercontent.com/6fc1e79b4aa226b24a756c4c8e20e5b049301a930449a7321d3e45f516e61601/68747470733a2f2f74656e6f722e636f6d2f766965772f6b746f2d6b6f756e6f746f72692d6b6f756e6f746f7269746f6b656e2d6c626f772d73746f726b686f6c646572732d6769662d32353637363438332e676966" width="25%">
6875

69-
## Setup and Usage
70-
71-
Follow the steps below to set up AICodeBot on your machine:
72-
73-
`pip install aicodebot`
74-
75-
The first time you run it, you'll be prompted to enter your OpenAI API key, which is required. You can get one for free on your [API key settings](https://platform.openai.com/account/api-keys").
76-
77-
```bash
78-
> aicodebot --help
79-
Usage: aicodebot [OPTIONS] COMMAND [ARGS]...
80-
81-
Options:
82-
-V, --version Show the version and exit.
83-
-h, --help Show this message and exit.
84-
85-
Commands:
86-
commit Generate a git commit message based on the diff, and then...
87-
fun-fact Tell me something interesting about programming or AI.
88-
version Print the version number.
89-
```
90-
9176
## Development
9277

9378
1. Clone the repository
@@ -106,5 +91,4 @@ mkvirtualenv --python=`which python3` aicodebot
10691

10792
```bash
10893
pip install -r requirements/requirements-dev.txt
109-
# Use requirements-dev.txt if you want to contribute to the project
11094
```

0 commit comments

Comments
 (0)