Skip to content

Commit

Permalink
Update readme about usage
Browse files Browse the repository at this point in the history
  • Loading branch information
dreampiggy committed Nov 1, 2019
1 parent 4097d56 commit b8e8226
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ let package = Package(
### Using `WebImage` to load network image

- [x] Supports placeholder and detail options control for image loading as SDWebImage
- [x] Supports progressive image loading
- [x] Supports success/failure/progress changes event for custom handling
- [x] Supports indicator with activity/progress indicator and customization
- [x] Supports built-in animation and transition, powered by SwiftUI
Expand All @@ -102,6 +103,7 @@ Note: This `WebImage` using `Image` for internal implementation, which is the be
### Using `AnimatedImage` to play animation

- [x] Supports network image as well as local data and bundle image
- [x] Supports animated progressive image loading
- [x] Supports animation control using the SwiftUI Binding
- [x] Supports indicator and transition, powered by SDWebImage and Core Animation
- [x] Supports advanced control like loop count, incremental load, buffer size
Expand Down Expand Up @@ -145,6 +147,8 @@ If you need animated image, `AnimatedImage` is the one to choose. Remember it su

But, because `AnimatedImage` use `UIViewRepresentable` and driven by UIKit, currently there may be some small incompatible issues between UIKit and SwiftUI layout and animation system. We try our best to match SwiftUI behavior, and provide the same API as `WebImage`, which make it easy to switch between these two types.

For more information, it's really recommended to check our demo below, to learn detailed API usage.

## Demo

To run the example using SwiftUI, following the steps:
Expand Down

0 comments on commit b8e8226

Please sign in to comment.