update registration + ollama health check

svilupp · Dec 3, 2023 · 97cc11e · 97cc11e
1 parent 6726be4
commit 97cc11e
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ For a quick start, simply set it via `ENV["OPENAI_API_KEY"] = "your-api-key"`
 Install PromptingTools:
 ```julia
 using Pkg
-Pkg.add("https://github.com/svilupp/PromptingTools.jl")
+Pkg.add("PromptingTools.jl")
 ```
 
 And we're ready to go!
@@ -33,7 +33,7 @@ ai"What is the capital of France?"
 # AIMessage("The capital of France is Paris.")
 ```
 
-Returned object is a light wrapper with generated message in field `:content` (eg, `ans.content`) for additional downstream processing.
+The returned object is a light wrapper with a generated message in the field `:content` (eg, `ans.content`) for additional downstream processing.
 
 You can easily inject any variables with string interpolation:
 ```julia

diff --git a/docs/src/examples/working_with_ollama.md b/docs/src/examples/working_with_ollama.md
@@ -5,7 +5,7 @@ EditURL = "../../../examples/working_with_ollama.jl"
 # Local models with Ollama.ai
 
 This file contains examples of how to work with [Ollama.ai](https://ollama.ai/) models.
-It assumes that you've already installated and launched the Ollama server. For more details or troubleshooting advice, see the [Frequently Asked Questions](@ref) section.
+It assumes that you've already installed and launched the Ollama server. Quick check: open the following website in your browser `http://127.0.0.1:11434/` and you should see the message "Ollama is running". For more details or troubleshooting advice, see the [Frequently Asked Questions](@ref) section.
 
 First, let's import the package and define a helper link for calling un-exported functions:
 

diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md
@@ -32,11 +32,11 @@ Resources:
 
 ## Installation
 
-The PromptingTools package has not yet been registered. But it can be installed using the following commands:
+PromptingTools can be installed using the following commands:
 
 ```julia
 using Pkg
-Pkg.add("https://github.com/svilupp/PromptingTools.jl")
+Pkg.add("PromptingTools.jl")
 ```
 
 Throughout the rest of this tutorial, we will assume that you have installed the