diff --git a/README.md b/README.md index d5d41a9..34b6357 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # ☎ CallGPT + A dead simple way to call the ChatGPT API from your machine -Try the client directly --> https://dmingod.github.io/CallGPT/chat_gpt.html +Try the client directly --> ## 👀 What is this? @@ -17,19 +18,17 @@ This is a dead simple way to have a ChatGPT client that you have control over an - You will need to use an API key from OpenAI. The API is fairly cheap, but nevertheless a paid service. -
- - -## Show me the goods: +## Show me the goods **Chat and responses:** - + +![Chat and responses](./readme_media/img-v6.jpg) **Custom actions executed by the bot:** - +![Custom actions executed by the bot](./readme_media/img-v5.jpg) -## 🤔 How to use: +## 🤔 How to use 1. Download this repo and save the HTML file on any location on your PC. @@ -43,25 +42,29 @@ This is a dead simple way to have a ChatGPT client that you have control over an 6. Enjoy! 🙂 +P.S. + To have a simple htm file with no external dependencies use (having node and npm installed): -## ⭐🤖🏃 Custom assistant: +```bash +npx -y -p inline-source-cli inline-source --compress true chat_gpt.html chatGpt.html +``` -You can add your own custom actions to this bot very easily -- there are 3 examples of doing this in the code. +## ⭐🤖🏃 Custom assistant +You can add your own custom actions to this bot very easily -- there are 3 examples of doing this in the code. You only need to do these 2 steps: + 1. Define the details of your custom action -- What function should be called, what is the name of the action etc. 2. Write your custom function -- This is the function that will do the work. - -#### 1. Define the details of your custom action: +### 1. Define the details of your custom action Make sure the key name (`___changeBackground` in this example) is the same as the `func_name_param_pattern` in the `custom_functions` dictionary. -
+![Define the details of your custom action](./readme_media/custom_bot_v4.png) - -#### 2. Write your custom function: +### 2. Write your custom function There are 3 examples of custom code examples shown of how you can have the bot execute some functions for you. @@ -69,48 +72,39 @@ There are 3 examples of custom code examples shown of how you can have the bot e 2. Change the text to white and it will change the text to white. 3. Fetch the top X stories from Hacker News and show it in the media tab. +- A very simple example that changes the background color of the page: -- A very simple example that changes the background color of the page:
-
- -- A slightly more complex example that fetches the top X stories from Hacker News and shows it in the media tab:
-
+ ![simple example](./readme_media/custom_bot_v5.png) +- A slightly more complex example that fetches the top X stories from Hacker News and shows it in the media tab: + ![complex example](./readme_media/custom_bot_v6.png) - -