Skip to content

Commit 9447b55

Browse files
Update README.md
1 parent 9d9b2c5 commit 9447b55

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ PHP global currency converter using fixer.io API (include bitcoin, silver and go
55

66
## Getting Started
77

8+
Register at fixer.io to download your free api key and replace with YOUR_API_KEY.
9+
810
```php
911
<?php
1012

@@ -86,6 +88,7 @@ PHP global currency converter using fixer.io API (include bitcoin, silver and go
8688
## Requirements
8789

8890
* PHP version 5.5 or later
91+
* Fixer.io free account
8992

9093
## Usage
9194

@@ -105,23 +108,22 @@ You can combine the examples shown above.
105108
## Installation
106109

107110
This library depends on composer for installation . For installation of composer, please visit [getcomposer.org](//getcomposer.org).
108-
Installation using a composer:
109-
110-
```
111-
composer require PatrykKosiba/currency-converter
112-
```
113-
114-
or download .zip for create vendor file.
111+
You can download .zip for compile composer.json file to create vendor directory.
115112

116113
## Why Use It
117114

118115
* Relaible Rates with fixer.io API
119116
* Over 160 currencies
120117
* Support for gold, silver and bitcoin exchange rates
121-
* Caching of rate, to avoid connecting to fixer.io multiple times
122-
* Conversion without currency code by country short code
118+
* Caching of rate to avoid connecting to fixer.io multiple times
119+
* Conversion without currency code by country short name (US, DE, PL, GB...)
123120
* Conversion of many currencies with one API reference
124121

122+
## Informations
123+
124+
A free account at fixer.io allows you to connect to the API 1000 times a month and information about currencies is provided once an hour. To use currency conversions efficiently, use the cache option.
125+
Setting the cache for 60 minutes allows for efficient use of services without restrictions on access to the API for any amount of time.
126+
125127
## Authors
126128

127129
MSc Patryk Kosiba

0 commit comments

Comments
 (0)