on master help sign in
Add README
5f83cb5Louis D'hauwe
README.mdnew file+79
@@ -0,0 +1,79 @@
1+<p align="center">
2+<img src="readme-resources/hero@2x.png" style="max-height: 300px;" alt="HueKit for iOS">
3+</p>
4+
5+<p align="center">
6+<a href="https://travis-ci.org/louisdh/huekit"><img src="https://travis-ci.org/louisdh/huekit.svg?branch=master" style="max-height: 300px;" alt="Build Status"/></a>
7+<br>
8+<a href="https://developer.apple.com/swift/"><img src="https://img.shields.io/badge/Swift-4.0-orange.svg?style=flat" style="max-height: 300px;" alt="Swift"/></a>
9+<a href="https://cocoapods.org/pods/HueKit"><img src="https://img.shields.io/cocoapods/v/HueKit.svg" style="max-height: 300px;" alt="Pod Version"/></a>
10+<a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4bc51d.svg?style=flat" style="max-height: 300px;" alt="Carthage Compatible"/></a>
11+<img src="https://img.shields.io/badge/platform-iOS-lightgrey.svg" style="max-height: 300px;" alt="Platform: iOS">
12+<br>
13+<a href="http://twitter.com/LouisDhauwe"><img src="https://img.shields.io/badge/Twitter-@LouisDhauwe-blue.svg?style=flat" style="max-height: 300px;" alt="Twitter"/></a>
14+<a href="https://paypal.me/louisdhauwe"><img src="https://img.shields.io/badge/Donate-PayPal-green.svg?style=flat" alt="Donate via PayPal"/></a>
15+</p>
16+
17+<p align="center">
18+<img src="readme-resources/example.gif" style="max-height: 1480px;" alt="HueKit for iOS">
19+</p>
20+
21+
22+## About
23+HueKit is a UI framework for iOS that provides components and utilities for building color pickers. Since each app may want a custom color picker, the design of this framework is geared towards reusability and allows for great customization.
24+
25+### Components
26+All components are marked `open`, so they can be inherited from. Also, all components are marked `@IBDesignable`, so they can be previewed in Interface Builder. Components that provide user interaction are subclassed from `UIControl`, you can observe a change in value by using `@IBAction`.
27+
28+#### ColorBarPicker
29+![](readme-resources/components/ColorBarPicker.png)
30+
31+#### ColorBarView
32+![](readme-resources/components/ColorBarView.png)
33+
34+#### ColorIndicatorView
35+![](readme-resources/components/ColorIndicatorView.png)
36+
37+#### ColorSquarePicker
38+![](readme-resources/components/ColorSquarePicker.png)
39+
40+#### ColorSquareView
41+![](readme-resources/components/ColorSquareView.png)
42+
43+#### SourceColorView
44+![](readme-resources/components/SourceColorView.png)
45+
46+
47+## Installation
48+
49+### [CocoaPods](http://cocoapods.org)
50+
51+To install, add the following line to your ```Podfile```:
52+
53+```ruby
54+pod 'HueKit', '~> 1.0'
55+```
56+
57+### [Carthage](https://github.com/Carthage/Carthage)
58+To install, add the following line to your ```Cartfile```:
59+
60+```ruby
61+github "louisdh/huekit" ~> 1.0
62+```
63+Run ```carthage update``` to build the framework and drag the built ```HueKit.framework``` into your Xcode project.
64+
65+
66+
67+## Requirements
68+
69+* iOS 10.0+
70+* Xcode 9.0+
71+
72+## Todo
73+
74+- [ ] Add tests
75+- [ ] Add documentation
76+
77+## License
78+
79+This project is available under the MIT license. See the LICENSE file for more info.
readme-resources/components/ColorBarPicker.pngnew file

Binary file not shown.

readme-resources/components/ColorBarView.pngnew file

Binary file not shown.

readme-resources/components/ColorIndicatorView.pngnew file

Binary file not shown.

readme-resources/components/ColorSquarePicker.pngnew file

Binary file not shown.

readme-resources/components/ColorSquareView.pngnew file

Binary file not shown.

readme-resources/components/SourceColorView.pngnew file

Binary file not shown.

readme-resources/example.gifnew file

Binary file not shown.

readme-resources/hero@2x.pngnew file

Binary file not shown.