Skip to content

Commit

Permalink
docs: improves overview text (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinhermawan authored Jun 8, 2024
1 parent 2d17673 commit 2850c75
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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"))
]
```

Expand All @@ -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)
4 changes: 2 additions & 2 deletions Sources/OllamaKit/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 2850c75

Please sign in to comment.