From 3e36a98a47af7e55906fb6eb6dbdaa3e469ce377 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Artur=20Ma=C5=82ecki?= Date: Fri, 25 Oct 2013 09:41:14 +0200 Subject: [PATCH] Added small pro tip to readme. --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0bd5d0..c707083 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: @@ -40,6 +47,17 @@ All attributes should be used in snake_case format instead of the CamelCase used in the official documentation. For example, for a user, you should call first_name instead of firstName. +### Pro-Tips + +In case of such error when you try to run tests: + + webmock-1.7.10/lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb:167:in `alias_method': undefined method `queue' for class `Typhoeus::Hydra' (NameError) + +probably you need to install: + + libcurl + + ## Documentation The full amiando API isn't fully implemented yet, however you can find here the