Skip to content

Commit

Permalink
Initialize section contents
Browse files Browse the repository at this point in the history
  • Loading branch information
peter279k committed Jul 5, 2018
1 parent ff84ad2 commit bb6f6a1
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Expand Up @@ -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

0 comments on commit bb6f6a1

Please sign in to comment.