diff --git a/README.md b/README.md index 82ce5ac..7a1aa30 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,40 @@ Monitor the crypto curreny via [CoinAPI](https://docs.coinapi.io/). - [License](#License) - [Copyright](#Copyright) +# Requirements +This package only support PHP version ```7.1+```. +# Installation +``` +composer require paycrypto/crypto-monitor +``` + +# Available Methods +This package supports the three functionalities fro now. + +- Get specific rate +- Get all rates +- Get the assets lists + +# Quick Start +You can see more details about the ```example.php``` to learn how to use this package quickly. + +# Usage +You can see more details about the ```example.php``` to learn how to use this package quickly. + +# Tests +You can checkout the ```tests``` folder and it includes the all available method tests. + +We also check that the code coverage is 100% now. + +# TODO +Coming soon... + +# Contribute +We're welcome to the all contributions and it should follow our contribution guide. + +# License +MIT license and it's in the ```LICENSE``` file. + +# Copyright +© 2018 PayCrypto, org