search

brick / money

A money and currency library for PHP
MIT License
1.65k stars 102 forks source link

Add explanation to README for import-currencies.php #10

Closed raphaelstolt closed 7 years ago

raphaelstolt commented 7 years ago

It's not really clear, at first sight, what the import-currencies.php is for, so a mention in the README.md would be helpful for project users.

It also should be prolly moved into a dedicated bin directory, so it doesn't get confused with Git repository configuration files like .travis.yml or .gitignore.

A Composer script for it would also make it easier, clearer, and well documented for the library users.

BenMorel commented 7 years ago

It's actually clearly documented in the script itself:

This script creates an array of currencies from a trusted source. The result of the script is exported in PHP format to be used by the library at runtime. This script is meant to be run by project maintainers, on a regular basis.

It should actually be export-ignored as well in #9!