sjs/CacheCreek
1
0
Fork 0
mirror of https://github.com/samsonjs/CacheCreek.git synced 2026-03-25 09:05:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Sami Samhuri 2016-09-06 18:28:09 -07:00
parent 9f38497427
commit 506d197a31
1 changed files with 5 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -4,6 +4,8 @@
`CacheCreek` provides an an LRU cache that allows you to store any item, including objects, pure Swift structs, enums (with associated values), etc. Simply put, it's designed to act like an `NSCache` for everything, including Swift variables.
![Swift version 3.0](https://img.shields.io/badge/Swift-3.0-brightgreen.svg?style=flat)] ![version 0.2.0 on Carthage](https://img.shields.io/badge/Carthage-0.2.0-brightgreen.svg?style=flat) [![MIT License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)](https://sjs.mit-license.org)
## Features
- Simply set, get, and remove items based on any key that is `Hashable`
@ -19,28 +21,6 @@
- tvOS 9.0+
- Xcode 7+
## Installation using CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects.
Because `CacheCreek` is written in Swift, you must use frameworks.
To integrate `CacheCreek` into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
pod 'CacheCreek'
```
Then, run the following command:
```bash
$ pod install
```
## Installation using Carthage
Add this to your `Cartfile`:
@ -93,4 +73,6 @@ print("\(cache.count)") // shows a count of 2
# License
[MIT License](https://sjs.mit-license.org)
Copyright (c) 2015 Christopher Luu [MIT License](https://github.com/nuudles/CacheIsKing/blob/f93527d8ccc3f88b2e0697e9fd78be28d40a3a26/LICENSE)
Copyright © 2016 Sami Samhuri [MIT License](https://sjs.mit-license.org)