From a52e8f7d0afddc31e757ed41374d39d7732dc095 Mon Sep 17 00:00:00 2001 From: Jun Nishimura Date: Sat, 2 Sep 2023 21:47:36 +0900 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b07b09f..7032ac6 100644 --- a/README.md +++ b/README.md @@ -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. -You can listen to music by selecting from the recommended list. +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 ``` @@ -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)