Merge pull request #17 from florianv/sponsors

Updated the documentation and added our sponsors

Author: florianv

README.md

@@ -1,30 +1,68 @@
-# FlorianvSwapBundle
+# <img src="https://s3.amazonaws.com/swap.assets/swap_logo.png" height="30px" width="30px"/> Symfony Swap
 
-[![Build status][travis-image]][travis-url]
-[![Version][version-image]][version-url]
-[![Downloads][downloads-image]][downloads-url]
+[![Build status](http://img.shields.io/travis/florianv/symfony-swap.svg?style=flat-square)](https://travis-ci.org/florianv/symfony-swap)
+[![Total Downloads](https://img.shields.io/packagist/dt/florianv/swap-bundle.svg?style=flat-square)](https://packagist.org/packages/florianv/symfony-swap)
+[![Version](http://img.shields.io/packagist/v/florianv/swap-bundle.svg?style=flat-square)](https://packagist.org/packages/florianv/symfony-swap)
 
-> Integrates the [Swap](https://github.com/florianv/swap) library with Symfony
+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.
+
+## QuickStart
+
+```bash
+$ composer require florianv/swap-bundle php-http/message php-http/guzzle6-adapter
+```
 
 ## Documentation
 
-[Read the Documentation for master](https://github.com/florianv/FlorianvSwapBundle/blob/master/Resources/doc/index.md)
+The complete documentation can be found [here](https://github.com/florianv/symfony-swap/blob/master/Resources/doc/index.md).
 
-All the installation instructions are located in the documentation.
+## Sponsors :heart_eyes: 
 
-## License
+We are proudly supported by the following echange rate providers offering *free plans up to 1,000 requests per day*:
 
-This bundle is under the MIT license. See the complete license in the bundle:
+<img src="https://s3.amazonaws.com/swap.assets/fixer_icon.png?v=2" height="20px" width="20px"/> **[Fixer](https://fixer.io)**
 
-```
-Resources/meta/LICENSE
-```
+Fixer is a simple and lightweight API for foreign exchange rates that supports up to 170 world currencies.
+They provide real-time rates and historical data, however, EUR is the only available base currency on the free plan.
+
+<img src="https://s3.amazonaws.com/swap.assets/currencylayer_icon.png" height="20px" width="20px"/> **[currencylayer](https://currencylayer.com)**
+
+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.
 
-[travis-url]: https://travis-ci.org/florianv/symfony-swap
-[travis-image]: http://img.shields.io/travis/florianv/symfony-swap.svg
+<img src="https://s3.amazonaws.com/swap.assets/1forge_icon.png" height="20px" width="20px"/> **[1Forge](https://1forge.com)**
 
-[version-url]: https://packagist.org/packages/florianv/swap-bundle
-[version-image]: http://img.shields.io/packagist/v/florianv/swap-bundle.svg
+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:
+
+| Service | Base Currency | Quote Currency | Historical |
+|---------------------------------------------------------------------------|----------------------|----------------|----------------|
+| [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 |
+| [National Bank of Romania](http://www.bnr.ro) | RON | * | Yes |
+| [Central Bank of the Republic of Turkey](http://www.tcmb.gov.tr) | * | TRY | No |
+| [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 |
+| [Google](https://www.google.com/finance) | * | * | 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 |
+| [Xignite](https://www.xignite.com) | * | * | Yes |
+| Array | * | * | Yes |
+
+## Credits
+
+- [Florian Voutzinos](https://github.com/florianv)
+- [All Contributors](https://github.com/florianv/symfony-swap/contributors)
+
+## License
 
-[downloads-url]: https://packagist.org/packages/florianv/swap-bundle
-[downloads-image]: https://img.shields.io/packagist/dt/florianv/swap-bundle.svg
+The MIT License (MIT). Please see [LICENSE](https://github.com/florianv/symfony-swap/blob/master/Resources/meta/LICENSE) for more information.

Resources/doc/index.md

@@ -1,4 +1,17 @@
-# Installation
+# Documentation
+
+## Index
+
+* [Installation](#installation)
+* [Configuration](#configuration)
+  * [Services](#services)
+  * [Cache](#cache)
+    * [Lifetime](#lifetime)
+    * [Cache type](#cache-type)
+* [Usage](#usage)
+* [Sponsors](#sponsors)
+
+## Installation
 
 ```bash
 composer require florianv/swap-bundle php-http/message php-http/guzzle6-adapter
@@ -19,17 +32,26 @@ public function registerBundles()
 }
 ```
 
-# Configuration
+## Configuration
+
+### Services
 
-## Builtin providers
+We recommend to use one of the [services that support our project](#sponsors), providing a free plan up to 1,000 requests per day.
+
+The complete list of all supported services is available here:
 
 ```yaml
 # app/config/config.yml
 florianv_swap:
     providers:
-        google: ~                          # Google Finance
         fixer:
             access_key: secret             # Fixer
+        currency_layer:                    # currencylayer
+            access_key: secret
+            enterprise: true
+        forge:                             # Forge
+            api_key: secret    
+        google: ~                          # Google Finance
         webservicex: ~                     # WebserviceX
         cryptonator: ~                     # Cryptonator
         russian_central_bank: ~            # Russian Central Bank
@@ -40,13 +62,8 @@ florianv_swap:
         open_exchange_rates:               # Open Exchange Rates
             app_id: secret
             enterprise: true
-        currency_layer:                    # currencylayer
-            access_key: secret
-            enterprise: true
         xignite:                           # Xignite
             token: secret
-        forge:                             # Forge
-            api_key: secret
         array:
             rates:
                 -
@@ -59,24 +76,30 @@ florianv_swap:
 ```
 
 You can register multiple providers, they will be called in chain regarding to their priorities (higher first).
-In this example __Fixer__ is the first one and __Google Finance__ is the second one:
+In this example, 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.
 
 ```yaml
 # app/config/config.yml
 florianv_swap:
     providers:
-        google: ~
-            #priority: 0 (default)
         fixer:
             access_key: secret
+            #priority: 0 (default)
+        currency_layer:                   
+            access_key: secret
+            enterprise: true
             priority: 1
+        forge:                            
+            api_key: secret
+            #priority: 2 (default)            
 ```
 
-## Cache
+### Cache
 
 Currently only some of the [Symfony Cache](https://symfony.com/doc/current/components/cache.html#available-simple-cache-psr-16-classes) adapters are supported.
 
-### Lifetime
+#### Lifetime
 
 You must specify a lifetime for your cache entries:
 
@@ -87,7 +110,7 @@ florianv_swap:
         ttl: 3600 # seconds
 ```
 
-### Cache type
+#### Cache type
 
 You can use a service id:
 
@@ -107,7 +130,7 @@ florianv_swap:
         type: apcu
 ```
 
-# Usage
+## Usage
 
 The Swap service is available in the container:
 
@@ -117,3 +140,22 @@ $swap = $this->get('florianv_swap.swap');
 ```
 
 For more information about how to use it, please consult the [Swap documentation](https://github.com/florianv/swap).
+
+## Sponsors
+
+We are proudly supported by the following echange rate providers offering *free plans up to 1,000 requests per day*:
+
+<img src="https://s3.amazonaws.com/swap.assets/fixer_icon.png?v=2" height="20px" width="20px"/> **[Fixer](https://fixer.io)**
+
+Fixer is a simple and lightweight API for foreign exchange rates that supports up to 170 world currencies.
+They provide real-time rates and historical data, however, EUR is the only available base currency on the free plan.
+
+<img src="https://s3.amazonaws.com/swap.assets/currencylayer_icon.png" height="20px" width="20px"/> **[currencylayer](https://currencylayer.com)**
+
+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.

Resources/meta/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 - 2016 Florian Voutzinos
+Copyright (c) 2014 - 2018 Florian Voutzinos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal