Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ian-mcdowell committed Feb 3, 2018
1 parent 141dca0 commit ebb5939
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 19 deletions.
22 changes: 22 additions & 0 deletions .travis.yml
@@ -0,0 +1,22 @@
language: objective-c
osx_image: xcode9.2
env:
global:
- LC_CTYPE=en_US.UTF-8
- LANG=en_US.UTF-8
- PROJECT=InputAssistant.xcodeproj
- IOS_FRAMEWORK_SCHEME="InputAssistant"
- IOS_SIM_SDK=iphonesimulator11.2
- IOS_DEV_SDK=iphoneos11.2
matrix:
- SCHEME="$IOS_FRAMEWORK_SCHEME" SDK="$IOS_SIM_SDK"
- SCHEME="$IOS_FRAMEWORK_SCHEME" SDK="$IOS_DEV_SDK"
script:
- set -o pipefail
- xcodebuild -version
- xcodebuild -showsdks
- xcodebuild -project "$PROJECT" -scheme "$SCHEME" -sdk "$SDK" -configuration Release ONLY_ACTIVE_ARCH=NO ENABLE_TESTABILITY=YES build;

branches:
only:
- master
61 changes: 42 additions & 19 deletions README.md
@@ -1,32 +1,30 @@
# InputAssistant

<p align="center">
<a href="https://github.com/IMcD23/Git">Git</a> &bull;
<b>InputAssistant</b> &bull;
<a href="https://github.com/IMcD23/TabView">TabView</a> &bull;
<a href="https://github.com/IMcD23/TiltedTabView">TiltedTabView</a>
</p>

--------

This library is a view that shows custom auto-complete suggestions for your UITextField / UITextView.

[![Build Status](http://img.shields.io/travis/IMcD23/InputAssistant.svg)](https://travis-ci.org/IMcD23/InputAssistant)
[![Version](https://img.shields.io/github/release/IMcD23/InputAssistant.svg)](https://github.com/IMcD23/InputAssistant/releases/latest)
![Package Managers](https://img.shields.io/badge/supports-Carthage%20%7C%20Cocoapods-orange.svg)
![Package Managers](https://img.shields.io/badge/supports-Carthage-orange.svg)
[![Contact](https://img.shields.io/badge/contact-%40ian__mcdowell-3a8fc1.svg)](https://twitter.com/ian_mcdowell)

<img src="Resources/Keyboard.png" height="300"> <img src="Resources/Keyboard_iPad.png" height="300">
<img src="Resources/Keyboard.png" height="300">
<img src="Resources/Keyboard_iPad.png" height="300">

## Installation
# Requirements

### Carthage
This library is available via [Carthage](https://github.com/Carthage/Carthage). To install, add the following to your Cartfile:
```
github IMcD23/InputAssistant
```
### Submodule
You can also add this project as a git submodule.
```
git submodule add https://github.com/IMcD23/InputAssistant path/to/InputAssistant
```
Run the command above, then drag the `InputAssistant.xcodeproj` into your Xcode project and add it as a build dependency.
* Xcode 9 or later

### ibuild
A Swift static library of this project is also available for the ibuild build system. Learn more about ibuild [here](https://github.com/IMcD23/ibuild)
# Usage

## Usage
This library provides an `InputAssistantView` class, that is designed to be set as the `inputAccessoryView` of a UITextView or UITextField.

It provides three areas that you can customize.
Expand All @@ -38,5 +36,30 @@ Use the `InputAssistantViewDataSource` protocol that allows you to do this custo

To react to a suggestion being tapped, conform to the `InputAssistantViewDelegate` protocol.

## Example
Take a look at the [Sample App](Sample) for an example of the implementation.
# Installation

## Carthage
To install InputAssistant using [Carthage](https://github.com/Carthage/Carthage), add the following line to your Cartfile:

```
github "IMcD23/InputAssistant" "master"
```

## Submodule
To install InputAssistant as a submodule into your git repository, run the following command:

```
git submodule add -b master https://github.com/IMcD23/InputAssistant.git Path/To/InputAssistant
git submodule update --init --recursive
```

Then, add the `.xcodeproj` in the root of the repository into your Xcode project, and add it as a build dependency.

## ibuild
A Swift static library of this project is also available for the ibuild build system. Learn more about ibuild [here](https://github.com/IMcD23/ibuild)

# Author
Created by [Ian McDowell](https://ianmcdowell.net)

# License
All code in this project is available under the license specified in the LICENSE file. However, since this project also bundles code from other projects, you are subject to those projects' licenses as well.

0 comments on commit ebb5939

Please sign in to comment.