Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vladzima committed Nov 18, 2023
1 parent 50fe571 commit bc8b2f4
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

topenai (terminal openai) — a simple command line interface tool to interact with OpenAI.

#### Installation
Installation
----------------

`pip install topenai`

Expand All @@ -16,14 +17,16 @@ To install the latest testing version (may contain more bugs), run:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ topenai

#### Features
Features
----------------

- Multiple chat threads
- Chat history
- Rename, delete and switch sessions


#### Usage:
Usage
----------------
Run `topenai` in your terminal

- Enter `/new` to start a new chat (`/n`)
Expand All @@ -36,7 +39,8 @@ Run `topenai` in your terminal
- `/help` to display this help message (`/h`)
- `/exit` to exit (`/e`)

#### Known issues
Known issues
----------------
- UUIDs of sessions instead of readable names
- Rename is not working

Expand All @@ -54,7 +58,8 @@ If you want to set this package up for directly editing it's source code (for co

pip install -e .

#### TODO
TODO
----------------
- Make chat history more accesible
- Allow OpenAI API fune-tuning parameters
- Migrate to official OpenAI python API client

0 comments on commit bc8b2f4

Please sign in to comment.