ReadME Updated

SwiftyContacts · Dec 12, 2017 · cca3382 · cca3382
1 parent 875da4c
commit cca3382
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -3,15 +3,23 @@
 [![Language: Swift 4](https://img.shields.io/badge/language-swift4-f48041.svg?style=flat-square)](https://developer.apple.com/swift)
 [![Version](https://img.shields.io/cocoapods/v/SwiftyContacts.svg?style=flat-square)](http://cocoapods.org/pods/SwiftyContacts)
 [![License](https://img.shields.io/cocoapods/l/SwiftyContacts.svg?style=flat-square)](http://cocoapods.org/pods/SwiftyContacts)
-[![Platform](https://img.shields.io/badge/platforms-iOS%209.0+%20%7C%20macOS%2010.11+%20%7C%20watchOS%202.0+-333333.svg?style=flat-square)](http://cocoapods.org/pods/SwiftyContacts)
+[![Platform](https://img.shields.io/badge/platforms-iOS%209.0+%20%7C%20macOS%2010.12+%20%7C%20watchOS%203.0+-333333.svg?style=flat-square)](http://cocoapods.org/pods/SwiftyContacts)
+[![Swift Package Manager](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg?style=flat-square)](https://github.com/apple/swift-package-manager)
+[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat-square)](https://github.com/Carthage/Carthage)
+[![CocoaPods compatible](https://img.shields.io/cocoapods/v/SwiftyContacts.svg?style=flat-square)](https://cocoapods.org/pods/SwiftyContacts)
 
 
 A Swift library for Contacts framework.
 
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Get started](#get-started)
+- [License](#license)
 
 ## Requirements
 
-- iOS 9.0+ 
+- iOS 9.0+ / Mac OS X 10.12+ /  watchOS 3.0+
+- Xcode 9.0+
 
 
 ## Installation
@@ -29,6 +37,86 @@ pod 'SwiftyContacts' , '~> 3.0.0'
 // Swift 3.x
 pod 'SwiftyContacts' , '~> 2.0.7'
 ```
+
+### CocoaPods
+
+[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
+
+```bash
+$ gem install cocoapods
+```
+
+To integrate SwiftyContacts into your Xcode project using CocoaPods, specify it in your `Podfile`:
+
+```ruby
+source 'https://github.com/CocoaPods/Specs.git'
+platform :ios, '8.0'
+use_frameworks!
+
+pod 'SwiftyContacts'
+
+```
+
+For swift 3.x use
+
+```ruby
+
+// Swift 3.x
+pod 'SwiftyContacts' , '~> 2.0.7'
+```
+
+Then, run the following command:
+
+```bash
+$ pod install
+```
+
+### Carthage
+
+[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
+
+You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
+
+```bash
+$ brew update
+$ brew install carthage
+```
+
+To integrate SwiftyContacts into your Xcode project using Carthage, specify it in your `Cartfile`:
+
+```ogdl
+github "SwiftyContacts/SwiftyContacts" ~> 3.0.8
+```
+### Swift Package Manager
+
+To use SwiftyContacts as a [Swift Package Manager](https://swift.org/package-manager/) package just add the following in your Package.swift file.
+
+``` swift
+import PackageDescription
+
+let package = Package(
+name: "HelloSwiftyContacts",
+dependencies: [
+.Package(url: "https://github.com/satishbabariya/SwiftyContacts", "3.0.8")
+]
+)
+```
+
+### Manually
+
+If you prefer not to use either of the aforementioned dependency managers, you can integrate SwiftyContacts into your project manually.
+
+
+#### Embeded Binaries
+
+- Download the latest release from https://github.com/satishbabariya/SwiftyContacts/releases
+- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
+- In the tab bar at the top of that window, open the "General" panel.
+- Click on the `+` button under the "Embedded Binaries" section.
+- Add the downloaded `SwiftyContacts.framework`.
+- And that's it!
+
+
 ## Get started
 
 Import SwiftyContacts into your porject

diff --git a/SwiftyContacts.xcworkspace/xcuserdata/wmt_ios_3.xcuserdatad/UserInterfaceState.xcuserstate b/SwiftyContacts.xcworkspace/xcuserdata/wmt_ios_3.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/fastlane/Fastfile b/fastlane/Fastfile
@@ -26,7 +26,7 @@ platform :ios do
   lane :deploy do
   ensure_git_branch
   version = version_bump_podspec(path: "SwiftyContacts.podspec")
-  git_commit(path: ["./SwiftyContacts.podspec", "./Example/Podfile.lock"], message: "Bumped to version #{version}")
+  git_commit(path: ["./SwiftyContacts.podspec"], message: "Bumped to version #{version}")
   push_to_git_remote(remote_branch: 'master', force: false, tags: true)
   changelog = changelog_from_git_commits
   github_release = set_github_release(

diff --git a/fastlane/report.xml b/fastlane/report.xml
@@ -5,52 +5,52 @@
 
 
 
-      <testcase classname="fastlane.lanes" name="0: Verifying required fastlane version" time="0.003239">
+      <testcase classname="fastlane.lanes" name="0: Verifying required fastlane version" time="0.00353">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="1: default_platform" time="0.002534">
+      <testcase classname="fastlane.lanes" name="1: default_platform" time="0.002391">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="2: ensure_git_branch" time="0.008243">
+      <testcase classname="fastlane.lanes" name="2: ensure_git_branch" time="0.009007">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="3: version_bump_podspec" time="0.004079">
+      <testcase classname="fastlane.lanes" name="3: version_bump_podspec" time="0.003647">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="4: git_commit" time="0.01813">
+      <testcase classname="fastlane.lanes" name="4: git_commit" time="0.04647">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="5: push_to_git_remote" time="6.310094">
+      <testcase classname="fastlane.lanes" name="5: push_to_git_remote" time="7.867723">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="6: changelog_from_git_commits" time="0.025408">
+      <testcase classname="fastlane.lanes" name="6: changelog_from_git_commits" time="0.030961">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="7: set_github_release" time="18.223619">
+      <testcase classname="fastlane.lanes" name="7: set_github_release" time="26.455918">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="8: git fetch --tags" time="1.230508">
+      <testcase classname="fastlane.lanes" name="8: git fetch --tags" time="1.296273">
 
       </testcase>
 
 
-      <testcase classname="fastlane.lanes" name="9: pod_push" time="104.361723">
+      <testcase classname="fastlane.lanes" name="9: pod_push" time="678.312955">
 
       </testcase>