Skip to content
This repository has been archived by the owner on Dec 3, 2019. It is now read-only.

Latest commit

 

History

History
67 lines (44 loc) · 3.29 KB

README.md

File metadata and controls

67 lines (44 loc) · 3.29 KB

Ohana

CI Status Version Carthage compatible License Platform

(This project is deprecated and not maintained.)

Ohana is a framework for working with a user's contacts on the iOS platform. It provides a component-based architecture for loading and processing contacts, as well as managing state such as contact selection and tagging. Whether loading contacts to display to a user, or processing contact data programatically, Ohana provides a simple, but extensible, framework for contact access in your application. Check out the wiki to learn how the library works. There are two quickstart guides available: one for Swift and one for Objective-C. If you have any questions, feel free to ask on Stack Overflow (tag "ohana").

Features

  • Easy to get started
  • Extensible architecture
  • Runtime-injectable components
  • Swift-compatible

Installation

CocoaPods

To integrate Ohana into your project using CocoaPods, add the following line to your Podfile:

pod 'Ohana', '~> 1.3'

Carthage

To consume Ohana using Carthage add this to your Cartfile:

github "uber/ohana-ios" ~> 1.3

You'll need to manually import Ohana, and its dependencies, libPhoneNumber and UberSignals.

Running the Examples App

  • Clone the repo git clone [email protected]:uber/ohana-ios.git
  • Open the Example directory cd ohana-ios/Example
  • run pod install
  • open Ohana.xcworkspace
  • Run the OhanaExample scheme in Xcode

Authors

Contributions

We'd love for you to contribute to our open source projects. Before we can accept your contributions, we kindly ask you to sign our Uber Contributor License Agreement.

  • If you find a bug, open an issue or submit a fix via a pull request.
  • If you have a feature request, open an issue or submit an implementation via a pull request
  • If you want to contribute, submit a pull request.

Check out the Contribution Guidelines for more information.

License

Ohana is released under the MIT license. See the LICENSE file for more info.