Skip to content

Commit 4cf3d42

Browse files
committed
Update the reamde about the project description
1 parent 3a0995b commit 4cf3d42

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,13 @@
99

1010
## What's for
1111

12-
This is an experimental project for [SDWebImage](https://github.com/SDWebImage/SDWebImage).
12+
SDWebImageSwiftUI is a SwiftUI image loading framework, which based on [SDWebImage](https://github.com/SDWebImage/SDWebImage).
1313

14-
It aims to ensure the following function available for users and try to do some experiments for Swift platform.
14+
It brings all your favorite features from SDWebImage, like async image loading, memory/disk caching, animated image playback and performances.
1515

16-
+ Swift Package Manager integration
17-
+ SwiftUI compatibility
18-
+ Swift source code compatibility
16+
Besides all these features, we do optimization for SwiftUI, like Binding, View Modifier, using the same design pattern to become a good SwiftUI citizen.
1917

20-
Note we do not guarantee the public API stable for current status until v1.0 version. Since SwiftUI is a new platform for us, we need to investigate the API design.
18+
Note we do not guarantee the public API stable for current status until v1.0 version. Since SwiftUI is a new platform for us. This framework is under development, feature requests, contributions, and GitHub stars are welcomed.
2119

2220
## Requirements
2321

@@ -151,6 +149,16 @@ Tips:
151149

152150
<img src='https://raw.githubusercontent.com/SDWebImage/SDWebImageSwiftUI/master/Example/Screenshot/Demo-watchOS.jpg' width=480 />
153151

152+
## Extra Notes
153+
154+
Besides all above things, this project can also ensure the following function available on Swift platform for SDWebImage itself.
155+
156+
+ SwiftUI compatibility
157+
+ Swift Package Manager integration
158+
+ Swift source code compatibility and Swifty
159+
160+
Which means, this project is one core use case and downstream dependency, which driven SDWebImage itself future development.
161+
154162
## Author
155163

156164
DreamPiggy

0 commit comments

Comments
 (0)