From 0965fa2faf9b4316d0c7cf3c9218a3fadae552dd Mon Sep 17 00:00:00 2001 From: Zach Date: Thu, 12 Oct 2023 07:23:28 -0600 Subject: [PATCH] Update README.md (#16) --- README.md | 43 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f6d89c..062a818 100644 --- a/README.md +++ b/README.md @@ -4,37 +4,45 @@ Picture is a useful Swift Package Manager project that simplifies the process of displaying multiple images in SwiftUI. It supports both local and remote images and handles the UI, loading, and caching of images. Picture is an excellent tool for enhancing the visual appeal of apps while reducing the time and effort required for image loading and caching. +## Features + +- Display multiple images in SwiftUI with ease +- Support for both local and remote images +- Automatic handling of image loading and caching +- Simplified API for seamless integration +- Enhanced visual appeal for your apps + ## Example Usages ```swift // Single Image or UIImage var body: some View { - Picture(image: image) + Picture(image: image) } // Single URL var body: some View { - Picture(url: imageURL) + Picture(url: imageURL) } // Multiple Images or UIImages var body: some View { - Picture(images: images) + Picture(images: images) } // Multiple URLs var body: some View { - Picture(urls: imageURLs) + Picture(urls: imageURLs) } // Multiple URLs or Images let remoteAndLocalImages: [PictureSource] = [ - .local(image), - .remote(url) + .local(image), + .remote(url) ] var body: some View { - Picture(remoteAndLocalImages) + Picture(remoteAndLocalImages) } ``` @@ -42,6 +50,25 @@ var body: some View { ```swift public init(sources: [PictureSource]) { - self.sources = sources + self.sources = sources } ``` + +## Installation + +To integrate Picture into your project using Swift Package Manager, simply add the following dependency to your `Package.swift` file: + +```swift +dependencies: [ + .package(url: "", from: "1.0.0") +] + +``` + +## Requirements + +- iOS 17.0+ + +## License + +Picture is available under the MIT license. See the [LICENSE](https://github.com/0xOpenBytes/Picture/blob/main/LICENSE) file for more info.