Skip to content

Commit

Permalink
Added banner image to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
btfranklin committed Jul 25, 2024
1 parent d304dad commit 8b1fa83
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# CleverBird

![CleverBird banner](https://raw.githubusercontent.com/btfranklin/CleverBird/main/.github/social%20preview/CleverBird_social_preview.jpg "CleverBird: Easily connect your Swift application to OpenAI's chat endpoints with a superior, best-in-class DX. 100% open source, 100% free.")

[![Platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbtfranklin%2FCleverBird%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/btfranklin/CleverBird)
[![Swift versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbtfranklin%2FCleverBird%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/btfranklin/CleverBird)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/btfranklin/CleverBird/blob/main/LICENSE)
Expand All @@ -18,11 +20,13 @@ Please note that `CleverBird` is an *unofficial* package, not provided by OpenAI
## Features

### Core Features

- Asynchronous API calls with Swift's async/await syntax
- Streamed responses for real-time generated content
- Built-in token counting for usage limit calculations

### Specialized Features

- Token Encoding: Facilitates token counting and encoding through the `TokenEncoder` class.
- Document Embedding and Similarity Queries: Utilize the `EmbeddedDocumentStore` class for managing and querying document similarities.

Expand Down

0 comments on commit 8b1fa83

Please sign in to comment.