From 2850c75f728bd25a9d772d68b63ef443e32ea28a Mon Sep 17 00:00:00 2001
From: Kevin Hermawan <84965338+kevinhermawan@users.noreply.github.com>
Date: Sun, 9 Jun 2024 05:18:40 +0700
Subject: [PATCH] docs: improves overview text (#29)

---
 README.md                                            | 12 ++++--------
 .../OllamaKit/Documentation.docc/Documentation.md    |  4 ++--
 2 files changed, 6 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index d4d3f50..eb69c65 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,15 @@
 
 [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fkevinhermawan%2FOllamaKit%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/kevinhermawan/OllamaKit) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fkevinhermawan%2FOllamaKit%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/kevinhermawan/OllamaKit)
 
-A Swift library to interact with the [Ollama](https://github.com/jmorganca/ollama) API
+[Ollama](https://github.com/ollama/ollama) client for Swift
 
 ## Overview
 
-`OllamaKit` is a Swift library crafted to streamline interactions with the Ollama API. It encapsulates the complexities of network communication and data processing, providing a simplified and efficient interface for Swift applications to communicate with the Ollama API.
+`OllamaKit` is a Swift library that streamlines interactions with the Ollama API. It handles the complexities of network communication and data processing behind the scenes, providing a simple and efficient way to integrate the Ollama API.
 
 ## Primary Use
 
-`OllamaKit` is primarily designed for use within [Ollamac](https://github.com/kevinhermawan/Ollamac), a macOS app for interacting with the Ollama models. While the library offers comprehensive functionalities for Ollama API interaction, its features and optimizations are specifically aligned with the requirements of `Ollamac`.
+`OllamaKit` is primarily developed to power the [Ollamac](https://github.com/kevinhermawan/Ollamac), a macOS app for interacting with Ollama models. Although the library provides robust capabilities for integrating the Ollama API, its features and optimizations are tailored specifically to meet the needs of the Ollamac.
 
 ## Documentation
 
@@ -22,7 +22,7 @@ You can add `OllamaKit` as a dependency to your project using Swift Package Mana
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/kevinhermawan/OllamaKit.git", .upToNextMajor(from: "1.0.0"))
+    .package(url: "https://github.com/kevinhermawan/OllamaKit.git", .upToNextMajor(from: "5.0.0"))
 ]
 ```
 
@@ -34,10 +34,6 @@ Alternatively, in Xcode:
 4. Choose the version you want to add. You probably want to add the latest version.
 5. Click `Add Package`.
 
-## Acknowledgements
-
-- [Alamofire](https://github.com/Alamofire/Alamofire)
-
 ## Used By
 
 - [Ollamac](https://github.com/kevinhermawan/Ollamac)
diff --git a/Sources/OllamaKit/Documentation.docc/Documentation.md b/Sources/OllamaKit/Documentation.docc/Documentation.md
index 4a6c7d0..26f9647 100644
--- a/Sources/OllamaKit/Documentation.docc/Documentation.md
+++ b/Sources/OllamaKit/Documentation.docc/Documentation.md
@@ -1,7 +1,7 @@
 # ``OllamaKit``
 
-A Swift library for interacting with the Ollama API.
+Ollama client for Swift
 
 ## Overview
 
-``OllamaKit`` is a Swift library crafted to streamline interactions with the Ollama API. It encapsulates the complexities of network communication and data processing, providing a simplified and efficient interface for Swift applications to communicate with the Ollama API.
+``OllamaKit`` is a Swift library that streamlines interactions with the Ollama API. It handles the complexities of network communication and data processing behind the scenes, providing a simple and efficient way to integrate the Ollama API.