Skip to content

Commit 03d06c6

Browse files
author
Michael Shannon Potter
committed
Update README
- Update logo - Add CocoaPod section - Fix explanation for UUID and sourceImageUUID - Use Gravatar for contributor images
1 parent 84a329f commit 03d06c6

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<a href="http://www.path.com/" target="_blank"><img src="https://s3.amazonaws.com/fast-image-cache/readme-resources/path-logo.png" width="227" height="86" alt="Path Logo"></a>
1+
![Fast Image Cache Logo](http://f.cl.ly/items/162R3I2i0w2s371j0W03/logo.png)
22

3-
# Fast Image Cache
3+
---
44

55
Fast Image Cache is an efficient, persistent, and—above all—fast way to store and retrieve images in your iOS application. Part of any good iOS application's user experience is fast, smooth scrolling, and Fast Image Cache helps make this easier.
66

@@ -143,6 +143,12 @@ The `FastImageCacheDemo` Xcode project requires Xcode 5.0 or greater and is conf
143143

144144
### Integrating Fast Image Cache
145145

146+
#### CocoaPods
147+
148+
For easy project integration, Fast Image Cache is available as a [CocoaPod](http://cocoapods.org).
149+
150+
#### Manually
151+
146152
- Clone this repository, or [download the latest archive of `master`](https://github.com/path/FastImageCache/archive/master.zip).
147153
- From the `FastImageCache` root directory, copy the source files from the inner [`FastImageCache`](./FastImageCache) subdirectory to your Xcode project.
148154
- Import [`FICImageCache.h`](./FastImageCache/FICImageCache.h) wherever you use the image cache.
@@ -204,11 +210,17 @@ Here is an example implementation of the `FICEntity` protocol.
204210

205211
```objective-c
206212
- (NSString *)UUID {
207-
return _userID;
213+
CFUUIDBytes UUIDBytes = FICUUIDBytesFromMD5HashOfString(_userID);
214+
NSString *UUID = FICStringWithUUIDBytes(UUIDBytes);
215+
216+
return UUID;
208217
}
209218

210219
- (NSString *)sourceImageUUID {
211-
return [_userPhotoURL absoluteString];
220+
CFUUIDBytes sourceImageUUIDBytes = FICUUIDBytesFromMD5HashOfString([_userPhotoURL absoluteString]);
221+
NSString *sourceImageUUID = FICStringWithUUIDBytes(sourceImageUUIDBytes);
222+
223+
return sourceImageUUID;
212224
}
213225

214226
- (NSURL *)sourceImageURLWithFormatName:(NSString *)formatName {
@@ -377,15 +389,15 @@ The takeaway is that Fast Image Cache sacrifices disk usage to achieve a faster
377389

378390
## Contributors
379391

380-
<a href="https://twitter.com/mallorypaine" target="_blank"><img src="https://s3.amazonaws.com/fast-image-cache/readme-resources/mallorypaine.jpeg" width="85" height="85" alt="Mallory Paine"></a>
392+
<a href="https://twitter.com/mallorypaine" target="_blank"><img src="http://www.gravatar.com/avatar/76db5d6bdcb64ac9e86e6a521ab57f03.jpg?s=85" alt="Mallory Paine"></a>
381393
**Mallory Paine** — Author and Original API Design
382394
<a href="https://twitter.com/mallorypaine" target="_blank">@mallorypaine</a>
383395

384396
Mallory is the Director of Mobile Engineering at Path, previously a member of the original iOS team at Apple.
385397

386398
---
387399

388-
<a href="https://twitter.com/LucasTizma" target="_blank"><img src="https://s3.amazonaws.com/fast-image-cache/readme-resources/michaelpotter.jpeg" width="85" height="85" alt="Michael Potter"></a>
400+
<a href="https://twitter.com/LucasTizma" target="_blank"><img src="http://www.gravatar.com/avatar/2005b2ed368913850076bb52cee79713.jpg?s=85" alt="Michael Potter"></a>
389401
**Michael Potter** — Documentation and API Refactoring
390402
<a href="https://twitter.com/LucasTizma" target="_blank">@LucasTizma</a>
391403

0 commit comments

Comments
 (0)