Skip to content

Commit

Permalink
Updated documentation material
Browse files Browse the repository at this point in the history
  • Loading branch information
florianv committed May 8, 2019
1 parent 7501fa7 commit 1142ecf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 19 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
[![Scrutinizer](https://img.shields.io/scrutinizer/g/florianv/laravel-swap.svg?style=flat-square)](https://scrutinizer-ci.com/g/florianv/laravel-swap)
[![Version](http://img.shields.io/packagist/v/florianv/laravel-swap.svg?style=flat-square)](https://packagist.org/packages/florianv/laravel-swap)

Swap allows you to retrieve currency exchange rates from various services such as **[Fixer](https://fixer.io)**, **[currencylayer](https://currencylayer.com)** or **[1Forge](https://1forge.com)**
and optionally cache the results.
Swap allows you to retrieve currency exchange rates from various services such as **[Fixer](https://fixer.io)** or **[currencylayer](https://currencylayer.com)** and optionally cache the results.

## QuickStart

Expand Down Expand Up @@ -96,11 +95,6 @@ They provide real-time rates and historical data, however, EUR is the only avail
Currencylayer provides reliable exchange rates and currency conversions for your business up to 168 world currencies.
They provide real-time rates and historical data, however, USD is the only available base currency on the free plan.

<img src="https://s3.amazonaws.com/swap.assets/1forge_icon.png" height="20px" width="20px"/> **[1Forge](https://1forge.com)**

1Forge provides Forex and Cryptocurrency quotes for over 700 unique currency pairs.
They provide the fastest price updates available of any provider, however, they don’t support smaller currencies or historical data.

## Services

Here is the list of the currently implemented services:
Expand All @@ -109,14 +103,13 @@ Here is the list of the currently implemented services:
|---------------------------------------------------------------------------|----------------------|----------------|----------------|
| [Fixer](https://fixer.io) | EUR (free, no SSL), * (paid) | * | Yes |
| [currencylayer](https://currencylayer.com) | USD (free), * (paid) | * | Yes |
| [1Forge](https://1forge.com) | * (free but limited or paid) | * (free but limited or paid) | No |
| [European Central Bank](https://www.ecb.europa.eu/home/html/index.en.html) | EUR | * | Yes |
| [Exchange Rates Api](https://exchangeratesapi.io/) | * | * | Yes |
| [National Bank of Romania](http://www.bnr.ro) | RON | * | Yes |
| [Central Bank of the Republic of Turkey](http://www.tcmb.gov.tr) | * | TRY | Yes |
| [Central Bank of the Czech Republic](https://www.cnb.cz) | * | CZK | Yes |
| [Central Bank of Russia](https://cbr.ru) | * | RUB | Yes |
| [WebserviceX](http://www.webservicex.net) | * | * | No |
| [1Forge](https://1forge.com) | * (free but limited or paid) | * (free but limited or paid) | No |
| [Cryptonator](https://www.cryptonator.com) | * Crypto (Limited standard currencies) | * Crypto (Limited standard currencies) | No |
| [CurrencyDataFeed](https://currencydatafeed.com) | * (free but limited or paid) | * (free but limited or paid) | No |
| [Open Exchange Rates](https://openexchangerates.org) | USD (free), * (paid) | * | Yes |
Expand Down
3 changes: 1 addition & 2 deletions config/swap.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
|
| Here is the config spec for each service:
|
| * "central_bank_of_czech_republic", "central_bank_of_republic_turkey", "european_central_bank", "exchange_rates_api",
| * "central_bank_of_czech_republic", "central_bank_of_republic_turkey", "european_central_bank", "google",
| "national_bank_of_romania", "webservicex", "russian_central_bank", "cryptonator" can be enabled with "true" as value.
|
| * 'fixer' => [
Expand Down Expand Up @@ -66,7 +66,6 @@
'services' => [
'fixer' => ['access_key' => 'YOUR_KEY', 'enterprise' => false],
'currency_layer' => ['access_key' => 'secret', 'enterprise' => false],
'forge' => ['api_key' => 'secret'],
],

/*
Expand Down
10 changes: 2 additions & 8 deletions doc/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Copy the [configuration](config/swap.php) to `/config/swap.php` if you wish to o

## Configuration

By default Swap uses the [Fixer](http://fixer.io) service, and will fallback to [currencylayer](https://currencylayer.com) and then [1Forge](https://1forge.com), in case of failure.
By default Swap uses the [Fixer](http://fixer.io) service, and will fallback to [currencylayer](https://currencylayer.com) in case of failure.

If you wish to use different services, you can modify the `services` configuration:

Expand All @@ -88,7 +88,6 @@ If you wish to use different services, you can modify the `services` configurati
'services' => [
'fixer' => ['access_key' => 'YOUR_KEY'],
'currency_layer' => ['access_key' => 'secret', 'enterprise' => false],
'forge' => ['api_key' => 'secret'],
]
```

Expand Down Expand Up @@ -337,14 +336,14 @@ Here is the complete list of supported services and their possible configuration
'services' => [
'fixer' => ['access_key' => 'YOUR_KEY'],
'currency_layer' => ['access_key' => 'secret', 'enterprise' => false],
'forge' => ['api_key' => 'secret'],
'european_central_bank' => true,
'exchange_rates_api' => true,
'national_bank_of_romania' => true,
'central_bank_of_republic_turkey' => true,
'central_bank_of_czech_republic' => true,
'russian_central_bank' => true,
'webservicex' => true,
'forge' => ['api_key' => 'secret'],
'cryptonator' => true,
'currency_data_feed' => ['api_key' => 'secret'],
'open_exchange_rates' => ['app_id' => 'secret', 'enterprise' => false],
Expand Down Expand Up @@ -379,8 +378,3 @@ They provide real-time rates and historical data, however, EUR is the only avail

Currencylayer provides reliable exchange rates and currency conversions for your business up to 168 world currencies.
They provide real-time rates and historical data, however, USD is the only available base currency on the free plan.

<img src="https://s3.amazonaws.com/swap.assets/1forge_icon.png" height="20px" width="20px"/> **[1Forge](https://1forge.com)**

1Forge provides Forex and Cryptocurrency quotes for over 700 unique currency pairs.
They provide the fastest price updates available of any provider, however, they don’t support smaller currencies or historical data.

0 comments on commit 1142ecf

Please sign in to comment.