From 1c13b3cf5436f9de7b18dd5c18cd3fd00386c85a Mon Sep 17 00:00:00 2001 From: Kizito Nwose Date: Sun, 8 Oct 2017 13:16:42 +0100 Subject: [PATCH] Update README with Carthage usage instructions. --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f8252ef..5441904 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,15 @@ [![Version](https://img.shields.io/cocoapods/v/CountryPickerView.svg?style=flat)](http://cocoapods.org/pods/CountryPickerView) [![Platform](https://img.shields.io/badge/Platform-iOS-00BCD4.svg)](http://cocoapods.org/pods/CountryPickerView) [![License](https://img.shields.io/badge/License-MIT-8D6E63.svg)](https://github.com/kizitonwose/CountryPickerView/blob/master/LICENSE.md) +[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) CountryPickerView is a simple, customizable view for selecting countries in iOS apps. You can clone/download the repository and run the [demo project](/CountryPickerViewDemo) to see CountryPickerView in action. First run `pod install` from the CountryPickerViewDemo directory. - - - + + + @@ -28,6 +29,16 @@ target '' do end ``` +### Carthage + +[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. + +To install CountryPickerView through Carthage, simply add the following to your Cartfile: + +```ruby +github "kizitonwose/CountryPickerView" +``` + ### Manual 1. Put CountryPickerView repo somewhere in your project directory. @@ -119,7 +130,7 @@ The datasource functions define the internal(country list) view controler's beha func navigationTitle(in countryPickerView: CountryPickerView) -> String? ``` -- A navigation item button to be used if the internal view controller is presented(not pushed). If nil is returned, a default "Close" button is used. This fuction only enables you return a button customized the way you want. +- A navigation item button to be used if the internal view controller is presented(not pushed). If nil is returned, a default "Close" button is used. This function only enables you return a button customized the way you want. ```swift func closeButtonNavigationItem(in countryPickerView: CountryPickerView) -> UIBarButtonItem? ```