Skip to content

Commit fdbe500

Browse files
committed
add podspec
1 parent f549bec commit fdbe500

File tree

2 files changed

+26
-16
lines changed

2 files changed

+26
-16
lines changed

AlgoliaSearch-Client-Swift.podspec

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Pod::Spec.new do |s|
2+
s.name = 'AlgoliaSearch-Client-Swift'
3+
s.version = '1.1.0'
4+
s.license = 'MIT'
5+
s.summary = 'Algolia Search API Client for iOS & OS X written in Swift.'
6+
s.homepage = 'https://github.com/algolia/algoliasearch-client-swift'
7+
s.author = { 'Algolia' => '[email protected]' }
8+
s.source = { :git => 'https://github.com/algolia/algoliasearch-client-swift.git', :tag => s.version }
9+
10+
s.ios.deployment_target = '8.0'
11+
s.osx.deployment_target = '10.9'
12+
13+
s.source_files = 'Source/*.swift'
14+
s.requires_arc = true
15+
end

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,18 @@
22

33

44

5-
[Algolia Search](http://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
6-
Algolia's Search API makes it easy to deliver a great search experience in your websites and mobile applications by providing:
75

8-
* REST and JSON based API
9-
* Search against infinite attributes from a single search box
10-
* Instant search as you type experience
11-
* Relevance and popularity ranking
12-
* Global language support
13-
* Typo tolerance in any language
14-
* Smart highlighting
15-
* Facet as you type
16-
* Geo awareness
17-
* 99.99% SLA
18-
* First class data security
6+
[Algolia Search](http://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
197

8+
Our Swift client lets you easily use the [Algolia Search API](https://www.algolia.com/doc/rest_api) from your backend. It wraps the [Algolia Search REST API](http://www.algolia.com/doc/rest_api).
209

2110

2211
[![Build Status](https://travis-ci.org/algolia/algoliasearch-client-swift.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-client-swift)
2312
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
13+
[![CocoaPods](https://img.shields.io/cocoapods/v/AlgoliaSearch-Client-Swift.svg)]()
14+
[![CocoaPods](https://img.shields.io/cocoapods/l/AlgoliaSearch-Client-Swift.svg)]()
2415
[![](http://img.shields.io/badge/OS%20X-10.9%2B-lightgrey.svg)]()
2516
[![](http://img.shields.io/badge/iOS-8.0%2B-lightgrey.svg)]()
26-
[![GitHub release](https://img.shields.io/github/release/algolia/algoliasearch-client-swift.svg)](https://github.com/algolia/algoliasearch-client-swift/releases/latest)
2717

2818

2919

@@ -67,7 +57,7 @@ To setup your project, follow these steps:
6757

6858

6959

70-
1. [Download and add sources](https://github.com/algolia/algoliasearch-client-swift/archive/master.zip) to your project (you will also need to add [Alamofire](https://github.com/Alamofire/Alamofire) in your project) or use [Carthage](https://github.com/Carthage/Carthage) by adding `github "algolia/algoliasearch-client-swift"` in your Cartfile.
60+
1. [Download and add sources](https://github.com/algolia/algoliasearch-client-swift/archive/master.zip) to your project or use [Carthage](https://github.com/Carthage/Carthage) by adding `github "algolia/algoliasearch-client-swift"` in your Cartfile or use cocoapods by adding `pod 'AlgoliaSearch-Client-Swift', '~> 1.1'` in your Podfile.
7161
2. Add the `import AlgoliaSearch` call to your project
7262
3. Initialize the client with your ApplicationID and API-Key. You can find all of them on [your Algolia account](http://www.algolia.com/users/edit).
7363

@@ -81,6 +71,9 @@ let client = AlgoliaSearch.Client(appID: "YourApplicationID", apiKey: "YourAPIKe
8171

8272

8373

74+
75+
76+
8477
Quick Start
8578
-------------
8679

@@ -438,7 +431,7 @@ index.search(query, block: { (JSON, error) -> Void in
438431
439432
The server response will look like:
440433
441-
```javascript
434+
```json
442435
{
443436
"hits": [
444437
{
@@ -517,6 +510,7 @@ index.getObject("myID", attributesToRetrieve: ["firstname"], block: { (JSON, err
517510
518511
You can also retrieve a set of objects:
519512
513+
520514
```swift
521515
index.getObjects(["myID1", "myID2"], block: { (JSON, error) -> {
522516
// do something
@@ -527,6 +521,7 @@ index.getObjects(["myID1", "myID2"], block: { (JSON, error) -> {
527521
528522
529523
524+
530525
Delete an object
531526
-------------
532527

0 commit comments

Comments
 (0)