Skip to content

Commit 1c4aea8

Browse files
committed
add: readme
1 parent d9851ea commit 1c4aea8

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
11
# OpenAIImageClient
2+
3+
A lightweight Swift package for interacting with OpenAI's `gpt-image-1` model to generate or edit images using natural language prompts and image files.
4+
5+
## ✨ Features
6+
7+
- Supports multiple input images (`image[]`) for editing
8+
- Uses `multipart/form-data` requests to match OpenAI API requirements
9+
- Returns generated image data in decoded PNG format
10+
- Compatible with SwiftUI and UIKit
11+
- Swift Concurrency (`async/await`) support
12+
13+
## 🛠 Requirements
14+
15+
- iOS 15.0+ / macOS 12.0+
16+
- Swift 5.7+
17+
- Valid OpenAI API key
18+
- Network permission enabled
19+
20+
## 📦 Installation
21+
22+
Add to your project via **Swift Package Manager**:
23+
24+
```swift
25+
.package(url: "https://github.com/darya-varabei/OpenAIImageClient.git", from: "1.0.0")
26+

0 commit comments

Comments
 (0)