README

A library for describing fiat currencies, used by Openclerk and live on CryptFolio.

This extends on the abstract currency definitions provided by openclerk/currencies.

Because fiat currencies are not digitally connected, we can't do interesting things with them like we can with cryptocurrencies; this component only describes fiat currencies with their three-character codes.

Installing

Include openclerk/fiat as a requirement in your project composer.json, and run composer update to install it into your project:

{
  "require": {
    "openclerk/fiat": "dev-master"
  }
}

Currencies supported

Using

Get the name for a given currency:

$currency = new \Fiat\PolishZloty();
echo $currency->getName();   // returns "Polish złoty"
echo $currency->getURL();    // returns "http://en.wikipedia.org/wiki/Polish_z%C5%82oty"

Donate

Donations are appreciated.

Contributing

Pull requests that contribute new currencies are welcome.

TODO

Should fiat currencies have assets?
Generate README list of currencies/services automatically
Link to live APIs on CryptFolio
CI build server and link to test results

openclerk / fiat

Maintainers