Skip to content
This repository has been archived by the owner on Jul 30, 2020. It is now read-only.

Latest commit

 

History

History
97 lines (60 loc) · 3.2 KB

README.md

File metadata and controls

97 lines (60 loc) · 3.2 KB
Raw

Warning: Migrated

InstantSearch Core has been migrated to the main InstantSearch repository. You still can use the Core part of the InstantSearch separately from UI components by following the provided instructions. This repository is no longer supported, please create your issues and submit your contributions to the main InstantSearch repository.

InstantSearch iOS

If you're looking to build search interfaces on iOS with Algolia, then you should check out InstantSearch iOS which is built on top of this library, and provides UI building blocks to build search experiences. Otherwise, keep reading.

InstantSearch Core for Swift

This is the InstantSearch Core library for Swift, built on top of Algolia's Swift API Client, using Algolia's Search API. It works on macOS, iOS, tvOS and watchOS.

You can always find the latest version of the user documentation on Algolia Documentation.

Installation

If you use Swift version earlier than 4.2, you have to use the version 3.3 of InstantSearch Core. This version is outdated and not recommended for use.

CocoaPods

CocoaPods is a dependency manager for Cocoa projects.

To install InstantSearch, simply add the following line to your Podfile:

Swift 5.0

pod 'InstantSearchCore', '~> 6.5'

Swift 4.2+

pod 'InstantSearchCore', '~> 5.0'

Swift 4.1

pod 'InstantSearchcore', '~> 3.3'

Then, run the following command:

$ pod update

Carthage

Carthage is a simple, decentralized dependency manager for Cocoa.

To install InstantSearch, simply add the following line to your Cartfile:

Swift 5.0

github "algolia/instantsearch-core-swift" ~> 6.5

Swift 4.2+

github "algolia/instantsearch-core-swift" ~> 5.0

Swift 4.1

github "algolia/instantsearch-core-swift" ~> 3.3

Swift Package Manager

Swift Package Manager (SwiftPM) is a tool for managing the distribution of Swift code as well as C-family dependency. From Xcode 11, SwiftPM got natively integrated with Xcode.

InstantSearch Core support SwiftPM from version 6.4.0. To use SwiftPM, you should use Xcode 11 to open your project. Click File -> Swift Packages -> Add Package Dependency, enter InstantSearch Core repo's URL. After select the package, you can choose the dependency type (tagged version, branch or commit). Then Xcode will setup all the stuff for you.

If you're a framework author and use InstantSearch Core as a dependency, update your Package.swift file:

let package = Package(
    // 6.5.0 ..< 7.0.0
    dependencies: [
        .package(url: "https://github.com/algolia/instantsearch-core-swift.git", from: "6.5.0")
    ],
    // ...
)

License

InstantSearch Core iOS is Apache 2.0 licensed.