Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leoz committed Jan 25, 2024
1 parent 5c59a78 commit 9c6303f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
File renamed without changes
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<p align="center">
<img src=./Assets/demo.gif" style="margin: auto; width: 250px"/>
</p>

## 🔭 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
Expand Down Expand Up @@ -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/).

<p align="center">
<img src="./demo.gif" alt="How to load image from URL asynchronously in SwiftUI"/>
</p>
## ✍️ 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.

0 comments on commit 9c6303f

Please sign in to comment.