Little md fixups + tip to embed all external scripts

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 --> <https://dmingod.github.io/CallGPT/chat_gpt.html>
 
 ## 👀 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.
 
-<br/>
-
-
-## Show me the goods:
+## Show me the goods
 
 **Chat and responses:**
-<img src="./readme_media/img-v6.jpg" />
+
+![Chat and responses](./readme_media/img-v6.jpg)
 
 **Custom actions executed by the bot:**
-<img src="./readme_media/img-v5.jpg" />
 
+![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,74 +42,69 @@ 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.
 
-<img src="./readme_media/custom_bot_v4.png" /> <br/>
+![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.
 
 1. Change the background color of the page --> you can say "change background to red" and the background will change to red.
 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: <br/>
-<img src="./readme_media/custom_bot_v5.png" /> <br/>
-
-- A slightly more complex example that fetches the top X stories from Hacker News and shows it in the media tab: <br/>
-<img src="./readme_media/custom_bot_v6.png" /> <br/> 
+  ![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)
 
-
-<video src='https://raw.githubusercontent.com/dminGod/CallGPT/main/callGPT.mov' />
-
-
+  <video src="https://user-images.githubusercontent.com/902512/223128048-3af67900-f3b4-4aad-809c-77bb7e476d94.mov" controls></video>
 
 To add more capabilities to the Bot:
+
 - Write a new function that does what you want.
 - In the bot initialization there is a list of commands that the bot can execute, the parameters it takes and when the function is called -- add your function to this list.
 - There is a part of the response message parsing where we check if there are any commands sent by the bot for us to execute -- here we make the call to the function we made.
 
-You can add stuff like calling the HackerNews API and showing it on the screen somewhere or call some local API to 
+You can add stuff like calling the HackerNews API and showing it on the screen somewhere or call some local API to
 control the lights or toaster or whatever you want.
 
-
-## 📝💪🏼 Write your own features:
+## 📝💪🏼 Write your own features
 
 1. Define the function that will do the work. For example:
-<img src="custom_bot_v1.png" /> <br/>
-
-
-2. Add a keyword that the bot can use to call this function
-
-<img src="./readme_media/custom_bot_v2.png" /> <br/>
-
-3. When you get a reply from the bot, see if any of your keywords is called, if yes, call your function:
-
-<img src="./readme_media/custom_bot_v3.png" /> <br/>
 
+   ![Define the function](./readme_media/custom_bot_v1.png)
 
+1. Add a keyword that the bot can use to call this function
 
-## Tweak it to your liking:
-<img src="readme_media/image-v3.png" />
+   ![Add a keyword](./readme_media/custom_bot_v2.png)
 
+1. When you get a reply from the bot, see if any of your keywords is called, if yes, call your function:
 
+   ![get a reply from the bot](./readme_media/custom_bot_v3.png)
 
+## Tweak it to your liking
 
+![Tweak it to your liking](./readme_media/image-v3.png)