Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JunNishimura committed Sep 2, 2023
1 parent ce0a4b6 commit a52e8f7
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,21 @@
# πŸ“– Overview
Chatify is a TUI(Terminal User Interface) tool that combines the OpenAI API with the Spotify API, allowing an AI bot to recommend the music you are looking for through conversation.

<strong>You can listen to music by selecting from the recommended list. </strong>
1. You can find the music you are looking for by answering questions.
2. You can listen to the music by selecting the track recommended by chatify.
3. You can store results of recommendations as playlists.

# ⚠️ Notice
Unfortunately, Chatify is currently not free to use; you need to have a Spotify Premium account and pay to use the OpenAI API.

Also, it is recommended that the terminal is set to full-screen size when to use Chatify.

# πŸ‘œ Prerequisites
Chatify requires two things.
1. You need to have [a Spotify Premium Account](https://www.spotify.com/premium/) to use Spotify API.
2. You need to have [a OpenAI account](https://platform.openai.com/login) to use OpenAI API.

# πŸ’» How to use
**It is recommended that the terminal is set to full-screen size when to use Chatify.**

## 1. Install
### Homebrew Tap
```
Expand Down Expand Up @@ -68,5 +70,28 @@ Let's talk to Chatify and embark on a journey to discover new music!
$ chatify hey
```

# ⌨️ Operation
| Key | Action |
| ---- | ---- |
| tab | switch the view |
| characters | input words |
| q, ctrl+c | quit |
| enter | answer, select |
| ↑, ↓ | move in list |
| ←, β†’ | turn page |

# πŸ”¨ Options
## `greeting` command
### `-p`, `--port`
Flag to specify the port number for Spotify authorization. Default number is 8888.

## `hey` command
### `-n`, `--number`
Flag to specify the number of recommendations. Default number is 25 and maximum number is 100.

### `-p`, `--playlist`
Flag to enable chatify to make playlist based on the recommendation. Default is false.


# πŸͺ§ License
Chatify is released under MIT License. See [MIT](https://raw.githubusercontent.com/JunNishimura/Chatify/main/LICENSE)

0 comments on commit a52e8f7

Please sign in to comment.