From 9c6303fc650ab6b6a477dc04ffb8cca7d70ed8ac Mon Sep 17 00:00:00 2001 From: leoz Date: Wed, 24 Jan 2024 19:50:21 -0500 Subject: [PATCH] Update Readme --- demo.gif => Assets/demo.gif | Bin README.md | 26 ++++++++++++++++++-------- 2 files changed, 18 insertions(+), 8 deletions(-) rename demo.gif => Assets/demo.gif (100%) diff --git a/demo.gif b/Assets/demo.gif similarity index 100% rename from demo.gif rename to Assets/demo.gif diff --git a/README.md b/README.md index 57c47f6..d5076d0 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ # CachedImage +[![Build](https://github.com/leoz/CachedImage/actions/workflows/swift.yml/badge.svg?branch=master)](https://github.com/leoz/CachedImage/actions/workflows/swift.yml) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoz%2FCachedImage%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/leoz/CachedImage) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoz%2FCachedImage%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/leoz/CachedImage) +![License](https://img.shields.io/github/license/leoz/CachedImage) + +

+ +

+ +## 🔭 Overview `CachedImage` is a SwiftUI component to asynchronously load and display an image provided by its URL. This package is based on the [AsyncImage](https://github.com/V8tr/AsyncImage) project published by [Vadim Bulavin](https://github.com/V8tr) and described in the [Asynchronous Image Loading from URL in SwiftUI](https://www.vadimbulavin.com/asynchronous-swiftui-image-loading-from-url-with-combine-and-swift/) article. -## Usage +## 🛠️ Usage + +### Quick Start ```swift import CachedImage @@ -39,14 +49,14 @@ struct ContentView: View { } ``` -## Demo +### Demo Program -Check the demo project provided [here](./Demo/). +Check the demo project provided here: [Demo](./Demo/). -

- How to load image from URL asynchronously in SwiftUI -

+## ✍️ Author + +[Vadim Bulavin](https://github.com/V8tr) & [Leonid Zolotarev](https://github.com/leoz) -## License +## 📃 License -[Unlicensed](./LICENSE.md) +`CachedImage` is available under the Unlicense. See the [LICENSE](./LICENSE.md) file for more info.