|
1 | | -# About EGOCache 2.x |
2 | | -EGOCache is a simple, thread-safe key value cache store. It has native support for `NSString`, `UI/NSImage`, and `NSData`, but can store anything that implements `<NSCoding>`. All cached items expire after the timeout, which by default, is one day. |
| 1 | +# EGOCache |
| 2 | +EGOCache is a simple, thread-safe key value cache store for macOS, iOS, tvOS and watchOS. |
3 | 3 |
|
4 | | -# Requirements |
| 4 | +It has native support for `NSString`, `UIImage`, `NSImage`, and `NSData`, but can store anything that implements `<NSCoding>`. All cached items expire after the timeout, which by default, is one day. |
5 | 5 |
|
6 | | -* ARC |
7 | | -* Blocks |
8 | | -* iOS or OS X |
| 6 | +## Installation |
9 | 7 |
|
10 | | -# Changes in 2.0 |
| 8 | +### Carthage |
11 | 9 |
|
12 | | -The public interface in 2.0 is largely the same, with the exception of `[EGOCache currentCache]` being deprecated in favor of `[EGOCache globalCache]`. You can now create your own instances of EGOCache and tell it to store wherever, this can be good for dividing up caches in different sections of your app. |
| 10 | +``` |
| 11 | +github "enormego/EGOCache" ~> 2.2.0 |
| 12 | +``` |
13 | 13 |
|
14 | | -Internally, EGOCache was largely rewritten to take advantage of libdispatch and is far more stable/performant when handling saves from multiple threads than it was in the past. |
| 14 | +### CocoaPods |
15 | 15 |
|
16 | | -One other notable internal change for users upgrading from 1.0 to be aware of, is UIImage's are no longer stored via `UIImagePNGRepresentation`. They're stored now by archiving UIImage itself, which allows us to retain information such as image scale, orientation, and also store the image in it's native type, so JPEG's are no longer inflated to PNG sizes. If you were previously saving images via `setImage:forKey:`, but for some reason retrieving them via `dataForKey:`, you'll need to update your code to account for this. |
| 16 | +``` |
| 17 | +pod 'EGOCache', '~> 2.2.0' |
| 18 | +``` |
17 | 19 |
|
18 | | -# Questions |
19 | | -Feel free to contact [email protected] if you need any help with EGOCache. |
| 20 | +### Without a dependency manager |
20 | 21 |
|
21 | | -# License |
22 | | -Copyright (c) 2015 enormego |
| 22 | +Drag EGOCache.h and EGOCache.m into your project. |
| 23 | + |
| 24 | +## License |
| 25 | +Copyright (c) 2017 enormego |
23 | 26 |
|
24 | 27 | Permission is hereby granted, free of charge, to any person obtaining a copy |
25 | 28 | of this software and associated documentation files (the "Software"), to deal |
|
0 commit comments