Skip to content

Commit 4ebe0fd

Browse files
authored
Update README.md
1 parent 3989b6c commit 4ebe0fd

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
This is a Swift community-driven repository for interfacing with the [OpenAI](https://platform.openai.com/docs/api-reference/) public API.
1616

1717
- [Introduction](#introduction)
18-
- [Installation](#%EF%B8%8F-installation)
18+
- [Demo App](#demo-app)
19+
- [Installation New Project](#%EF%B8%8F-installation-new-project)
1920
- [Usage](#-usage)
2021
- [Secure your API Key using a .plist](#secure-your-api-key-using-a-plist)
2122
- [Images](#images)
@@ -36,11 +37,23 @@ This is a Swift community-driven repository for interfacing with the [OpenAI](ht
3637

3738
## Introduction
3839

39-
`SwiftOpenAI` is a (community-maintained) powerful and easy-to-use Swift SDK designed to seamlessly integrate with `OpenAI's API`. The main goal of this SDK is to simplify the process of accessing and interacting with OpenAI's cutting-edge AI models, such as GPT-4, GPT-3, and future models, all within your Swift applications.
40+
`SwiftOpenAI` is a community-maintained, powerful, and easy-to-use Swift SDK. It is designed to integrate seamlessly with OpenAI's API. The main goal of this SDK is to make it simpler to access and interact with OpenAI's advanced AI models, such as GPT-4, GPT-3, and future models, all within your Swift applications.
4041

41-
![SwiftOpenAI Demo](https://github.com/SwiftBeta/SwiftOpenAI/assets/74316958/7a3d40c7-4859-454e-b4df-66d31a2339b3)
42+
To help developers, I have created this demo app. You only need to add your OpenAI API Key in the SwiftOpenAI.plist. Inside the demo app, you have access to the core features of the SDK.
4243

43-
## ⚙️ Installation
44+
![SwiftOpenAI Demo](https://github.com/SwiftBeta/SwiftOpenAI/assets/74316958/8a93f3ad-f895-4471-b8af-196dc052d336)
45+
46+
## Demo App
47+
48+
To try the demo app, you only need to open Demo.xcodeproj.
49+
50+
<img width="623" alt="Demo" src="https://github.com/SwiftBeta/SwiftOpenAI/assets/74316958/3f3d6765-5a96-48d3-9173-46bb2923dca1">
51+
52+
After that, you will see the project. The next step is to compile your project on one of the simulators (or a real device)
53+
54+
<img width="2672" alt="Xcode Demo" src="https://github.com/SwiftBeta/SwiftOpenAI/assets/74316958/279ba6f9-474e-4512-a802-fbfae95f2398">
55+
56+
## ⚙️ Installation New Project
4457

4558
Open Xcode and open the `Swift Package Manager` section, then paste the Github URL from this repository (Copy -> https://github.com/SwiftBeta/SwiftOpenAI.git) to install the Package in your project.
4659

0 commit comments

Comments
 (0)