From 9505350c7ccd7ce624a5b54e42481bfeeb5ec73f Mon Sep 17 00:00:00 2001 From: Krzysztof Modras Date: Tue, 24 Sep 2013 15:28:49 +0200 Subject: [PATCH] README: basic info on how to use Amiando gem + fixed link --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0bd5d0..a7cb956 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,14 @@ Otherwise it will use `multi_json`'s bundled json parser. ## Basic usage The gem has been implemented with the idea that requests can be done in -parallel using [Typhoeus](https://github.com/dbalatero/typhoeus). +parallel using [Typhoeus](https://github.com/typhoeus/typhoeus). + +First the API key and base URL need to be configured properly: + + Amiando.base_url = 'https://www.amiando.com' + Amiando.api_key = 'your API key' + +To get API key use this [link](http://developers.amiando.com/index.php/How_to_get_your_API_key). You can query multiple requests and run then like this: