Skip to content

Commit

Permalink
Updates README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
polpielladev committed Apr 4, 2023
1 parent 955551f commit 1404d90
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,24 @@ https://user-images.githubusercontent.com/24246926/227801499-c3729d95-086c-4d7a-

## Installation

Currently, chatty can only be installed using [Mint 🌱](https://github.com/yonaskolb/Mint):
There are currently three ways of installing the app: `homebrew`, `mint` and `directly from Github`.

### Homebrew

```bash
brew install polpielladev/homebrew-tap/chatty-cli
```

### Mint

```bash
mint install polpielladev/chatty-cli@main
```

### Manually

Every time a new version is available, a new Github release is created. You can download the latest version of the executable directly from the [releases page](https://github.com/polpielladev/chatty-cli/releases).

## Usage

Chatty communicates with the [OpenAI API]() to make use of the ChatGPT model. The first time you use the chatty, you will need to give it an API token using the `auth` command:
Expand All @@ -22,7 +34,6 @@ chatty auth

https://user-images.githubusercontent.com/24246926/227801076-e96d8e69-36ac-43bd-aefd-9cba554105a2.mp4


🔐 This token will be safely stored in the OSX Keychain and will only be read when needed. Chatty will only know the value of the token for during its execution.

If chatty has already been given a token, you can start a conversation by running chat command:
Expand Down

0 comments on commit 1404d90

Please sign in to comment.