feat: update readme

Author: riccardopersiani

README.md

@@ -1,12 +1,59 @@
-# eos-api
+## Oraclize EOS API - CDT 1.4.0 [![Join the chat at https://gitter.im/oraclize/eos-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oraclize/eos-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![[email protected]](https://camo.githubusercontent.com/5e89710c6ae9ce0da822eec138ee1a2f08b34453/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646f63732d536c6174652d627269676874677265656e2e737667)](http://docs.oraclize.it) [![HitCount](http://hits.dwyl.io/oraclize/eos-api.svg)](http://hits.dwyl.io/oraclize/eos-api) [![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
 
-Please refer to [our API documentation](http://docs.oraclize.it/#eos) to know more about the Oraclize API on EOSIO.
+ 
 
-## Oraclize `eos-api`
+Thanks to this __EOS API__, enriching your smart-contracts with external data using __Oraclize__ is very easy!
 
-Documentation: [docs.oraclize.it](http://docs.oraclize.it/#eos)
+In C++ it is as simple as including the __`eos_api.hpp`__ library that you'll find in this repository.
 
-Gitter public support channel: 
-[![Join the chat at https://gitter.im/oraclize/eos-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oraclize/eos-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+This will provide your contract with functions like __`oraclize_query(...)`__, which make it trivial for you to leverage our oracle technology straight away.
 
-[![HitCount](http://hits.dwyl.io/oraclize/eos-api.svg)](http://hits.dwyl.io/oraclize/eos-api)
+Simply import __Oraclize__ into your contract like so:
+
+```c++
+
+#include "oraclize/eos_api.hpp"
+
+```
+
+To learn more about the Oraclize technology, please refer to our __[documentation here](https://docs.oraclize.it)__.
+
+ 
+
+***
+
+ 
+
+### CDT Compatiiblity
+
+The `eos_api.hpp` library in this repo is compatible with the EOSIO CDT 1.4.0.
+
+For the Oraclize EOS API compatible with the CDT 1.6.1, just go to the [eosio.cdt-1.6.1](https://github.com/oraclize/eos-api/tree/eosio.cdt-1.6.1) branch.
+
+ 
+
+***
+
+ 
+
+### :computer: See It In Action!
+
+For working examples of how to integrate the __Oraclize__ EOS API into your own smart-contracts, head on over to the __[Oraclize EOS Examples](https://github.com/oraclize/eos-examples)__ repository. Here you'll find various examples that use __Oraclize__ to feed smart-contracts with data from a variety of external sources.
+
+ 
+
+***
+
+ 
+
+### :mega: __Get In Touch!__
+
+If you want to ask us something, or tell us something, there's loads of ways to get in touch:
+
+__❍__ We have a __[Twitter](https://twitter.com/oraclizeit)__
+
+__❍__ And a __[Gitter](https://gitter.im/oraclize/eos-api)__
+
+__❍__ Or a __[Website](https://provable.xyz)__
+
+__❍__ Plus a __[Github](https://github.com/oraclize)__