Skip to content

Commit

Permalink
Update readme / add license
Browse files Browse the repository at this point in the history
  • Loading branch information
lordkev committed Jul 1, 2015
1 parent 7730e39 commit 28ea5f9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 BuzzFeed, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -10,6 +10,8 @@ A Swift framework for storing entire web pages into a disk cache distinct from,
**Installation**
----------------

Mattress includes a wrapper around CommonCrypto so that it can be easily used from within Swift. You will need to make sure you include both the Mattress and CommonCrypto frameworks in your project.

**Carthage (Recommended)**

If you are not already using Carthage, you will need to install it using [Homebrew](http://brew.sh).
Expand All @@ -25,7 +27,7 @@ Once installed, add it to your Cartfile:
github "buzzfeed/Mattress" >= 1.0
```

You will then need to build using Carthage, and manually integrate the framework into your project.
You will then need to build using Carthage, and manually integrate both the Mattress and CommonCrypto frameworks into your project.

```
$ carthage build
Expand All @@ -50,7 +52,7 @@ pod 'Mattress', '~> 1.0.0'
1. Open the `Mattress` folder, and drag `Mattress.xcodeproj` into the file navigator of your app project. **NOTE: The Mattress project needs to be added somewhere under the target project or you won't be able to add it to your target dependencies.**
2. Ensure that the deployment target of the Mattress project matches that of the application target.
3. In your target's "Build Phases" panel, add `Mattress.framework` to the "Target Dependencies"
4. Click on the `+` button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add `Mattress.framework`.
4. Click on the `+` button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add both `Mattress.framework` and `CommonCrypto.framework`.

**Usage**
---------
Expand Down

0 comments on commit 28ea5f9

Please sign in to comment.