Skip to content

Commit 775aff5

Browse files
author
vvo
committed
prepare readme for JS client V3 release
1 parent 3fa72da commit 775aff5

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,8 @@
33

44

55
[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:
7-
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
196

7+
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).
208

219

2210
[![Build Status](https://travis-ci.org/algolia/algoliasearch-client-swift.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-client-swift)
@@ -81,6 +69,9 @@ let client = AlgoliaSearch.Client(appID: "YourApplicationID", apiKey: "YourAPIKe
8169

8270

8371

72+
73+
74+
8475
Quick Start
8576
-------------
8677

@@ -438,7 +429,7 @@ index.search(query, block: { (JSON, error) -> Void in
438429
439430
The server response will look like:
440431
441-
```javascript
432+
```json
442433
{
443434
"hits": [
444435
{
@@ -517,6 +508,7 @@ index.getObject("myID", attributesToRetrieve: ["firstname"], block: { (JSON, err
517508
518509
You can also retrieve a set of objects:
519510
511+
520512
```swift
521513
index.getObjects(["myID1", "myID2"], block: { (JSON, error) -> {
522514
// do something
@@ -527,6 +519,7 @@ index.getObjects(["myID1", "myID2"], block: { (JSON, error) -> {
527519
528520
529521
522+
530523
Delete an object
531524
-------------
532525
@@ -868,15 +861,15 @@ You can easily copy or rename an existing index using the `copy` and `move` comm
868861
869862
```swift
870863
// Rename MyIndex in MyIndexNewName
871-
client.moveIndex("MyIndex", dstIndexName: "MyIndexNewName", block: { (JSON, error) -> Void in
864+
client.moveIndex("MyIndex", to: "MyIndexNewName", block: { (JSON, error) -> Void in
872865
if let error = error {
873866
println("Move failure: \(error)")
874867
} else {
875868
println("Move success: \(JSON)")
876869
}
877870
})
878871
// Copy MyIndex in MyIndexCopy
879-
client.copyIndex("MyIndex", dstIndexName: "MyIndexCopy", block: { (JSON, error) -> Void in
872+
client.copyIndex("MyIndex", to: "MyIndexCopy", block: { (JSON, error) -> Void in
880873
if let error = error {
881874
println("Copy failure: \(error)")
882875
} else {

0 commit comments

Comments
 (0)