Skip to content

Commit 31e8994

Browse files
committed
update docs
1 parent ccb3344 commit 31e8994

File tree

3 files changed

+16
-292
lines changed

3 files changed

+16
-292
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Codegpt
22

3-
## 0.2.15
3+
## 0.3
44

55
A tool for using GPT just a little quicker. A nearly truly automated footgun. Learn how to revert with git before trying please.
66

@@ -21,7 +21,19 @@ Windows users can also use `setx` like:
2121

2222
from an admin console.
2323

24-
## Be careful! But try this
24+
## Your first (safe) command
25+
26+
One cool thing is generating documentation. GPT-3 has a token limit of 4000 for completions, so larger files will be chunked up.
27+
28+
```bash
29+
codegpt docs <paths>
30+
```
31+
32+
And it'll generate docs, one per file. This is great when you're coming into a codebase you've never seen before.
33+
34+
## Unsafe Commands
35+
36+
Everything else can modify files. Have someone hold your beer and try some of these (after you check it into git):
2537

2638
Usage
2739
To try Codegpt, you can run the following command:

poetry.lock

Lines changed: 0 additions & 288 deletions
This file was deleted.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[tool.poetry]
22
name = "codegpt"
3-
version = "0.2.15"
3+
version = "0.3.0"
44
license = "GPL-3.0-or-later"
5-
description = "A CLI tool for refactoring code using OpenAI's models"
5+
description = "A CLI tool for developers using GPT-3."
66
authors = ["John Partee"]
77
repository = "https://github.com/morganpartee/codegpt"
88
readme = "README.md"

0 commit comments

Comments
 (0)