diff --git a/README.md b/README.md index 46f2f5f..b404e1c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# currency-exchange -A currency exchange package for the Laravel framework. +# Currency Exchange Rate +A currency exchange package for the Laravel framework using Euro as the main currency. + + +## Getting Started +- Use composer to add this package to your laravel project + +``` +composer require teusbarros/currencyexchange +``` + +- That's all! You can start using the package on your application + +## The basic + +Now you have an endpoint located at: base_url/api/v1/exchange + +You can see this endpoint documentation in the swagger.json or swagger.yaml files.