add instructions for CocoaPods setup

This commit is contained in:
Laurin Quast
2018-07-19 09:46:27 +02:00
parent 82edb959d8
commit 4cc984d5da
2 changed files with 42 additions and 0 deletions

16
docs/caching.md Normal file
View File

@@ -0,0 +1,16 @@
# Caching
Caching is currently only supported on `iOS` platforms with a CocoaPods setup.
# Technology
The cache is backed by [SPTPersistentCache](https://github.com/spotify/SPTPersistentCache) and [DVAssetLoaderDelegate](https://github.com/vdugnist/DVAssetLoaderDelegate).
# How Does It Work
The caching is based on the url of the asset.
SPTPersistentCache is a LRU ([last recently used](https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_recently_used_(LRU))) cache.
By default files expire after 30 days and the maxmimum cache size is 100mb.
In a future release the cache might have more configurable options.