Commit d232bfe1 authored by Aral Balkan's avatar Aral Balkan

Update readme

parent 0e54d58a
# Handle
Handle is an easy-to-use, expressive Swift micro-library for handling notifications.
Handle is an easy-to-use, expressive Swift library for handling notifications.
## Installation
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
Latest version; Swift 3 (and non-breaking updates) – recommended.
### 1. Update your Cartfile
**Swift 3 (latest version)**
```
git "git@source.ind.ie:project/handle.git" ~> 4.0
......@@ -24,9 +26,13 @@ To stay on Swift 2.2:
git "git@source.ind.ie:project/handle.git" ~> 3.0.1
```
The Handle demonstration apps do not have any dependencies, just open up the Handle.xcworkspace in Xcode and build and run the iOS and macOS demos.
### 2. Add the framework to your Xcode project
See the [detailed installation instructions](#detailed-installation-instructions), below, for instructions on how to add Handle to your own apps.
[Follow the instructions on Carthage’s readme](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).
### 3. There is no three.
The Handle demonstration apps do not have any dependencies, just open up the Handle.xcworkspace in Xcode and build and run the iOS and macOS demos.
## Getting started
......@@ -91,23 +97,7 @@ Read more about the library [in this blog post](https://ind.ie/labs/blog/handle)
## On performance
Note that Handle is optimised for ease of authoring, beauty of interface and clarity of intent. I haven’t run into performance issues and hence haven’t felt the need to run any benchmarks at the moment but if you want maximum performance, using the NSNotificationCenter methods directly will give you shorter stack traces.
## Detailed installation instructions
### Carthage
1. Add the framework to your `Cartfile`. e.g.,
```git "git@source.ind.ie:project/handle.git" ~> 4.0```
2. [Follow the instructions on Carthage’s readme](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application).
#### macOS
1. Just drag the framework into the Linked Frameworks and Binaries section of your project (under General).
(For an example of manually adding the framework, see the iOS and macOS demo apps that ship with this framework.)
Note that Handle is optimised for ease of authoring, beauty of interface, and clarity of intent. I haven’t run into performance issues and hence haven’t felt the need to run any benchmarks at the moment but if you want maximum performance, using the NSNotificationCenter methods directly will give you shorter stack traces.
## Credits
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment