Doc improvements

codergeek121 · Jul 24, 2023 · 80008eb · 80008eb
1 parent efd8ea2
commit 80008eb
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -33,20 +33,16 @@ Read more about the setup command [here](docs/setup.md).
 You can chat with ChatGPT with:
 
 ```
+// Basic single command
 clai chat "Tell me a funny joke"
+
+// Use a preconfigured persona
+clai chat "Count to 10" --persona ruby
 ```
 
 This will send the given prompt to the API and display the generated completion.
 
-### Help
-
-To view the available commands and options, you can use the `help` command:
-
-```
-clai help
-```
-
-This will display a list of supported commands and their descriptions.
+Read more about the chat command [here](docs/chat.md).
 
 ### Starting a session
 
@@ -59,6 +55,18 @@ Your prompt: <Enter your prompt here><Enter>
 
 This will start a REPL like process to interact with the OpenAI api.
 
+Read more about the session command [here](docs/session.md).
+
+### Help
+
+To view the available commands and options, you can use the `help` command:
+
+```
+clai help
+```
+
+This will display a list of supported commands and their descriptions.
+
 ## Examples
 
 Here are a few examples to get you started:

diff --git a/docs/intro.md b/docs/intro.md
@@ -5,6 +5,6 @@ It's very basic at the moment. I'm currently trying to incorporate clai in my da
 
 `clai` currently supports OpenAI and needs a paid API key to work.
 
-My main use case currently is to have a terminal opened with a clai session and ask questions instead of googling.
+My main use case currently is to have a terminal permanently opened with a clai session and ask questions instead of googling.
 
 0.x.0 will be unstable and untested, I'm currently aiming to release a tested 1.0.0 soon. Please see [here](https://github.com/codergeek121/clai/CONTRIBUTING.MD) on how to contribute at the current stage of the project.
diff --git a/docs/setup.md b/docs/setup.md
@@ -2,4 +2,4 @@
 
 `clai setup` will create a config file with a base configuration.
 
-`clai setup --force` will overwrite the basic config with the default configuration. It's mainly useful in development of the gem.
+`clai setup --force` will overwrite the basic config with the default configuration. It's mainly useful for development of clai.