alemar11/JsonRPC

JsonRPC

Work in progress...

Requirements
Documentation
Installation
License

Requirements

iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
Xcode 9.0
Swift 4.0.2

Documentation

Documentation is available online.

http://www.tinrobots.org/JsonRPC/

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1.0+ is required to build JsonRPC 1.0.0+.

To integrate JsonRPC into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'JsonRPC', '~> 1.0'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate JsonRPC into your Xcode project using Carthage, specify it in your Cartfile:

github "tinrobots/JsonRPC" ~> 1.0.0

Run carthage update to build the framework and drag the built JsonRPC.framework into your Xcode project.

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. Once you have your Swift package set up, adding JsonRPC as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/tinrobots/JsonRPC.git", from: "1.0.0")
]

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate JsonRPC into your project manually.

Embedded Framework

Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

$ git init

Add JsonRPC as a git submodule by running the following command:

$ git submodule add https://github.com/tinrobots/JsonRPC.git

Open the new JsonRPC folder, and drag the JsonRPC.xcodeproj into the Project Navigator of your application's Xcode project.

It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
Select the JsonRPC.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.
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.
You will see two different JsonRPC.xcodeproj folders each with two different versions of the JsonRPC.framework nested inside a Products folder.

It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom JsonRPC.framework.
Select the top JsonRPC.framework for iOS and the bottom one for macOS.

You can verify which one you selected by inspecting the build log for your project. The build target for JsonRPC will be listed as either JsonRPC iOS, JsonRPC macOS, JsonRPC tvOS or JsonRPC watchOS.

License

JsonRPC is released under the MIT license. See LICENSE for details.

alemar11 / JsonRPC