Skip to content

Commit 3b65bbd

Browse files
dreampiggydreampiggy
committed
Update the readme and version number
1 parent 0c2356d commit 3b65bbd

File tree

4 files changed

+123
-5
lines changed

4 files changed

+123
-5
lines changed

‎README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![Version](https://img.shields.io/cocoapods/v/SDWebImageYYPlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageYYPlugin)
55
[![License](https://img.shields.io/cocoapods/l/SDWebImageYYPlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageYYPlugin)
66
[![Platform](https://img.shields.io/cocoapods/p/SDWebImageYYPlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageYYPlugin)
7+
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/SDWebImage/SDWebImageYYPlugin)
8+
[![codecov](https://codecov.io/gh/SDWebImage/SDWebImageYYPlugin/branch/master/graph/badge.svg)](https://codecov.io/gh/SDWebImage/SDWebImageYYPlugin)
79

810

911
## What's for
@@ -14,6 +16,8 @@ By using SDWebImageYYPlugin, you can use all you familiar SDWebImage's loading m
1416
And you can also use `YYCache` instead of `SDImageCache` for image cache system, which may better memory cache performance (By taking advanced of LRU algorithm), and disk cache performance (By taking advanced of sqlite blob storage)
1517

1618
## Usage
19+
20+
#### YYImage Plugin
1721
To load a network image, simply call the View Category method like UIImageView.
1822

1923
+ Objective-C
@@ -30,21 +34,41 @@ let imageView: YYAnimatedImageView
3034
imageView.sd_setImage(with: URL(string: "http://www.domain.com/path/to/image.gif"))
3135
```
3236

37+
#### YYCache Plugin
3338
To enable `YYCache` instead of `SDImageCache`, you can bind the cache for shared manager, or create a custom manager instead.
3439

40+
+ Objective-C
41+
42+
```objectivec
43+
// Use `YYCache` for shared manager
44+
SDWebImageManger.defaultImageCache = [YYCache cacheWithName:@"default"];
45+
```
46+
47+
+ Swift
48+
49+
```swift
50+
// Use `YYCache` for shared manager
51+
SDWebImageManger.defaultImageCache = YYCache(name: "name")
52+
```
53+
3554
You can also use `YYMemoryCache` or `YYDiskcache` to customize memory cache / disk cache only. See [Custom Cache](https://github.com/rs/SDWebImage/wiki/Advanced-Usage#custom-cache-50) wiki in SDWebImage.
3655

3756
+ Objective-C
3857

3958
```objectivec
40-
// Assign to shared manager
41-
SDWebImageManger.defaultCache = [YYCache sharedCache];
59+
// Use `YYMemoryCache` for shared `SDImageCache` memory cache implementation
60+
SDImageCacheConfig.defaultCacheConfig.memoryCacheClass = YYMemoryCache.class;
61+
// Use `YYDiskCache` for shared `SDImageCache` disk cache implementation
62+
SDImageCacheConfig.defaultCacheConfig.diskCacheClass = YYDiskCache.class;
4263
```
4364

4465
+ Swift
4566

4667
```swift
47-
SDWebImageManger.defaultCache = YYCache.shared
68+
// Use `YYMemoryCache` for `SDImageCache` memory cache implementation
69+
SDImageCacheConfig.default.memoryCacheClass = YYMemoryCache.self
70+
// Use `YYDiskCache` for `SDImageCache` disk cache implementation
71+
SDImageCacheConfig.default.diskCacheClass = YYDiskCache.self
4872
```
4973

5074
## Requirements
@@ -54,6 +78,8 @@ SDWebImageManger.defaultCache = YYCache.shared
5478

5579
## Installation
5680

81+
#### CocoaPods
82+
5783
SDWebImageYYPlugin is available through [CocoaPods](https://cocoapods.org). To install
5884
it, simply add the following line to your Podfile:
5985

@@ -68,6 +94,18 @@ pod 'SDWebImageYYPlugin/YYImage'
6894
pod 'SDWebImageYYPlugin/YYCache'
6995
```
7096

97+
#### Carthage
98+
99+
SDWebImageFLPlugin is available through [Carthage](https://github.com/Carthage/Carthage).
100+
101+
```
102+
github "SDWebImage/SDWebImageYYPlugin"
103+
```
104+
105+
Carthage does not support like CocoaPods' subspec, the built framework will contains both YYCache && YYImage support.
106+
107+
Note because of limit of [YYImage Carthage support](https://github.com/ibireme/YYImage#carthage), YYImage plugin with Carthage will not support WebP format. If you want to support WebP format, use CocoaPods instead.
108+
71109
## Author
72110

73111
DreamPiggy, [email protected]

‎SDWebImageYYPlugin.podspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Pod::Spec.new do |s|
1010
s.name = 'SDWebImageYYPlugin'
11-
s.version = '0.1.0'
11+
s.version = '0.1.1'
1212
s.summary = 'A short description of SDWebImageYYPlugin.'
1313

1414
# This description is used to generate tags and improve search results.

‎SDWebImageYYPlugin.xcodeproj/xcshareddata/xcschemes/SDWebImageYYPlugin.xcscheme

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<Scheme
3+
LastUpgradeVersion = "0940"
4+
version = "1.3">
5+
<BuildAction
6+
parallelizeBuildables = "YES"
7+
buildImplicitDependencies = "YES">
8+
<BuildActionEntries>
9+
<BuildActionEntry
10+
buildForTesting = "YES"
11+
buildForRunning = "YES"
12+
buildForProfiling = "YES"
13+
buildForArchiving = "YES"
14+
buildForAnalyzing = "YES">
15+
<BuildableReference
16+
BuildableIdentifier = "primary"
17+
BlueprintIdentifier = "325E27D9213BED3800044370"
18+
BuildableName = "SDWebImageYYPlugin.framework"
19+
BlueprintName = "SDWebImageYYPlugin"
20+
ReferencedContainer = "container:SDWebImageYYPlugin.xcodeproj">
21+
</BuildableReference>
22+
</BuildActionEntry>
23+
</BuildActionEntries>
24+
</BuildAction>
25+
<TestAction
26+
buildConfiguration = "Debug"
27+
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
28+
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
29+
shouldUseLaunchSchemeArgsEnv = "YES">
30+
<Testables>
31+
</Testables>
32+
<AdditionalOptions>
33+
</AdditionalOptions>
34+
</TestAction>
35+
<LaunchAction
36+
buildConfiguration = "Debug"
37+
selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
38+
selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
39+
launchStyle = "0"
40+
useCustomWorkingDirectory = "NO"
41+
ignoresPersistentStateOnLaunch = "NO"
42+
debugDocumentVersioning = "YES"
43+
debugServiceExtension = "internal"
44+
allowLocationSimulation = "YES">
45+
<MacroExpansion>
46+
<BuildableReference
47+
BuildableIdentifier = "primary"
48+
BlueprintIdentifier = "325E27D9213BED3800044370"
49+
BuildableName = "SDWebImageYYPlugin.framework"
50+
BlueprintName = "SDWebImageYYPlugin"
51+
ReferencedContainer = "container:SDWebImageYYPlugin.xcodeproj">
52+
</BuildableReference>
53+
</MacroExpansion>
54+
<AdditionalOptions>
55+
</AdditionalOptions>
56+
</LaunchAction>
57+
<ProfileAction
58+
buildConfiguration = "Release"
59+
shouldUseLaunchSchemeArgsEnv = "YES"
60+
savedToolIdentifier = ""
61+
useCustomWorkingDirectory = "NO"
62+
debugDocumentVersioning = "YES">
63+
<MacroExpansion>
64+
<BuildableReference
65+
BuildableIdentifier = "primary"
66+
BlueprintIdentifier = "325E27D9213BED3800044370"
67+
BuildableName = "SDWebImageYYPlugin.framework"
68+
BlueprintName = "SDWebImageYYPlugin"
69+
ReferencedContainer = "container:SDWebImageYYPlugin.xcodeproj">
70+
</BuildableReference>
71+
</MacroExpansion>
72+
</ProfileAction>
73+
<AnalyzeAction
74+
buildConfiguration = "Debug">
75+
</AnalyzeAction>
76+
<ArchiveAction
77+
buildConfiguration = "Release"
78+
revealArchiveInOrganizer = "YES">
79+
</ArchiveAction>
80+
</Scheme>

‎SDWebImageYYPlugin/Module/Info.plist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<key>CFBundlePackageType</key>
1616
<string>FMWK</string>
1717
<key>CFBundleShortVersionString</key>
18-
<string>0.1.0</string>
18+
<string>0.1.1</string>
1919
<key>CFBundleVersion</key>
2020
<string>$(CURRENT_PROJECT_VERSION)</string>
2121
<key>NSPrincipalClass</key>

0 commit comments

Comments
 (0)