Create README.md

Author: EbenezerGH

README.md

@@ -0,0 +1,49 @@
+# hello_etherscan
+
+hello_etherscan is just a wrapper for the [Etherscan Api](https://etherscan.io/apis).  There are many different network calls and it may be best to just abstract out this huge bulk of code into a module or library.
+
+## Getting Started
+
+This library is still in beta and not ready for it's first release, there are still a few more [issues](https://github.com/EbenezerGH/hello_etherscan/issues) to complete.
+
+To use this project as a module:
+
+Clone project or download
+```
+https://github.com/EbenezerGH/hello_etherscan.git
+```
+
+In your app directory's gradle, import the module
+```
+implementation project(':etherscanapi')
+```
+In your root directory's settings.gradle be sure to add the module into your include right after your previous module seperated by a comma [Example Implementation](https://github.com/EbenezerGH/hello_etherscan/blob/master/settings.gradle)
+```
+':etherscanapi'
+```
+
+Call `ApiKey.takeOff.setApiKey("[your api key here]")` if recording api usage in the etherscan.io console [see [Example implementation](https://github.com/EbenezerGH/hello_etherscan/blob/master/app/src/main/java/jfyg/etherscan/helloetherescan/HelloEtherscanApplication.kt)]
+```
+ApiKey.takeOff.setApiKey("1I7CRNU2QIU253UBPFVB5UV2C2PBDURAIYZ")
+```
+
+Lastly call the given function that's needed by creating an instance of one of the Etherscan Apis [accounts, contracts, transactions, blocks, eventLogs, geth, websockets, tokens, [stat](https://etherscan.io/apis#stats)]
+
+```
+Log.d(TAG, "The Status is ${stat.getNetworkStatus()}")
+Log.d(TAG, "The Message is ${stat.getNetworkMessage()}")
+Log.d(TAG, "The current price of Ether in Btc:  ${stat.getLastPriceInBtc()}")
+```
+```
+D/jfyg.etherscan.helloetherescan.MainActivity: The Status is 1
+D/jfyg.etherscan.helloetherescan.MainActivity: The Message is OK
+D/jfyg.etherscan.helloetherescan.MainActivity: The current price of Ether in Btc:  0.07416
+```
+
+## Authors
+
+* [**Ebenezer Ackon**](http://www.ebenezerackon.com/)
+Only me so far but eagerly accepting help :)
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.