Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/instantsearch-core-swift
⚡️ InstantSearch Core library for Swift and Objective-C
https://github.com/algolia/instantsearch-core-swift
algolia search swift
Last synced: 3 months ago
JSON representation
⚡️ InstantSearch Core library for Swift and Objective-C
- Host: GitHub
- URL: https://github.com/algolia/instantsearch-core-swift
- Owner: algolia
- License: apache-2.0
- Archived: true
- Created: 2016-07-25T08:27:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-20T18:43:53.000Z (over 4 years ago)
- Last Synced: 2024-04-11T05:18:28.388Z (9 months ago)
- Topics: algolia, search, swift
- Language: Swift
- Homepage: https://community.algolia.com/instantsearch-core-swift/
- Size: 8.19 MB
- Stars: 18
- Watchers: 72
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Warning: Migrated
InstantSearch Core has been migrated to the main [InstantSearch repository](https://github.com/algolia/instantsearch-ios). You still can use the Core part of the InstantSearch separately from UI components by following the [provided instructions](https://github.com/algolia/instantsearch-ios#installation). 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](https://github.com/algolia/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](https://github.com/algolia/algoliasearch-client-swift), using Algolia's [Search API](https://www.algolia.com/). It works on macOS, iOS, tvOS and watchOS.
You can always find the latest version of the **user documentation** on [Algolia Documentation](https://www.algolia.com/doc/api-reference/widgets/ios/).
## 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](https://cocoapods.org/) is a dependency manager for Cocoa projects.
To install InstantSearch, simply add the following line to your Podfile:
#### Swift 5.0
```ruby
pod 'InstantSearchCore', '~> 6.5'
```
#### Swift 4.2+
```ruby
pod 'InstantSearchCore', '~> 5.0'
```
#### Swift 4.1
```ruby
pod 'InstantSearchcore', '~> 3.3'
```
Then, run the following command:
```bash
$ pod update
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a simple, decentralized dependency manager for Cocoa.
To install InstantSearch, simply add the following line to your Cartfile:
#### Swift 5.0
```ruby
github "algolia/instantsearch-core-swift" ~> 6.5
```
#### Swift 4.2+
```ruby
github "algolia/instantsearch-core-swift" ~> 5.0
```
#### Swift 4.1
```ruby
github "algolia/instantsearch-core-swift" ~> 3.3
```
#### Swift Package Manager
[Swift Package Manager](https://swift.org/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](https://github.com/algolia/instantsearch-core-swift.git).
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:
```swift
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](LICENSE.md).