Skip to content

Commit 0b30ead

Browse files
committed
Update README.md
1 parent f981827 commit 0b30ead

File tree

2 files changed

+57
-24
lines changed

2 files changed

+57
-24
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ bundle-install:
99

1010
pod-install:
1111
bundle exec pod install --no-repo-update
12+
13+
setup: brew-install
14+
bundle install
15+
bundle exec pod install --no-repo-update

README.md

Lines changed: 53 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# ICInputAccessory
22

3-
Customized text fields used in the iCook app.
3+
Customized text fields used in the [iCook app](https://itunes.apple.com/app/id554065086).
4+
Try <https://testflight.icook.tw>.
45

5-
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
66
[![Build Status](https://travis-ci.org/polydice/ICInputAccessory.svg?branch=develop)](https://travis-ci.org/polydice/ICInputAccessory)
7+
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
8+
[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/ICInputAccessory.svg)](https://img.shields.io/cocoapods/v/ICInputAccessory.svg)
9+
![Platform](https://img.shields.io/cocoapods/p/ICInputAccessory.svg?style=flat)
10+
![Swift 2.1.1](https://img.shields.io/badge/Swift-2.1.1-orange.svg)
711

812
### ICKeyboardDismissTextField
913

@@ -12,20 +16,14 @@ Customized text fields used in the iCook app.
1216
### ICTokenField
1317

1418
* A horizontal scrolling UI that groups input texts.
15-
* Easy to add and delete tokens.
19+
* Easy to add, select and delete tokens.
1620
* Customizable icon and colors.
1721

18-
<table>
19-
<tr>
20-
<th>ICKeyboardDismissTextField</th>
21-
<th rowspan="2"></th>
22-
<th>ICTokenField</th>
23-
</tr>
24-
<tr>
25-
<th><img src="https://raw.githubusercontent.com/polydice/ICInputAccessory/gh-pages/screenshots/ICKeyboardDismissTextField.png" width="90%" /></th>
26-
<th><img src="https://raw.githubusercontent.com/polydice/ICInputAccessory/gh-pages/screenshots/ICTokenField.png" width="90%" /></th>
27-
</tr>
28-
</table>
22+
![ICTokenField](https://raw.githubusercontent.com/polydice/ICInputAccessory/gh-pages/screenshots/ICTokenField.gif)
23+
24+
## Requirements
25+
26+
iOS 8.0+ with Xcode 7.2 or above.
2927

3028
## Installation
3129

@@ -37,21 +35,22 @@ Customized text fields used in the iCook app.
3735
github "polydice/ICInputAccessory"
3836
```
3937

40-
* On your application targets' **General** settings tab, in the **Linked Frameworks and Libraries** section, drag and drop `ICInputAccessory.framework` from the Carthage/Build directory.
38+
* Follow the [instruction](https://github.com/Carthage/Carthage#if-youre-building-for-ios) to add the framework to an iOS project.
4139

42-
* On your application targets’ **Build Phases** settings tab, click the **+** icon and choose **New Run Script Phase**. Create a Run Script with the following contents:
40+
### Install via [CocoaPods](http://guides.cocoapods.org/)
4341

44-
```
45-
/usr/local/bin/carthage copy-frameworks
46-
```
42+
* Create a `Podfile` with the following specification and run `pod install`.
4743

48-
and add the following path to **Input Files**:
44+
```rb
45+
platform :ios, '8.0'
46+
use_frameworks!
4947

50-
```
51-
$(SRCROOT)/Carthage/Build/iOS/ICInputAccessory.framework
48+
pod 'ICInputAccessory'
5249
```
5350

54-
* For more information, please check out the [Carthage Documentation](https://github.com/Carthage/Carthage#if-youre-building-for-ios).
51+
### Install Manually
52+
53+
* Everything you need resides in the `Source` directory. Drag those files to a project.
5554

5655
## Usage
5756

@@ -107,7 +106,7 @@ public var normalTokenAttributes: [String : NSObject]? { get set }
107106
public var highlightedTokenAttributes: [String : NSObject]? { get set }
108107
```
109108

110-
See `Example/CustomizedTokenField.swift` for more detail.
109+
See `Example/CustomizedTokenField.swift` for more details.
111110

112111
#### ICTokenFieldDelegate
113112

@@ -118,3 +117,33 @@ public var highlightedTokenAttributes: [String : NSObject]? { get set }
118117
* `tokenFieldWillReturn(_:)`
119118
* `tokenField(_:didEnterText:)`
120119
* `tokenField(_:didDeleteText:atIndex:)`
120+
121+
## Development
122+
123+
Meke sure you have [Homebrew](http://brew.sh/) installed, then run in the project root:
124+
125+
```
126+
make setup
127+
```
128+
129+
Tasks for testing:
130+
131+
```
132+
rake -T
133+
```
134+
135+
## Contributing
136+
137+
Thank you for being interested in contributing to this project. We'd love to hear your ideas!
138+
139+
Please fork this repository, create a branch named like `feature/some-new-feature` and send us a pull request to make this project better.
140+
141+
## Contact
142+
143+
[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/polydice)
144+
145+
## License
146+
147+
Copyright (c) 2016 [Polydice, Inc.](https://polydice.com)
148+
149+
**ICInputAccessory** is released under the MIT license. See [LICENSE](https://github.com/polydice/ICInputAccessory/blob/master/LICENSE) for details.

0 commit comments

Comments
 (0)