From c1615a7aa0f8e1fbc14acd3ab35b5d64da43a1da Mon Sep 17 00:00:00 2001 From: Eric Ribeiro Date: Thu, 25 Aug 2022 20:19:00 -0700 Subject: [PATCH] docs: add rounding errors warning --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fed19d7..6d85818 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,13 @@ I don't know, but I had to use a lot of it. I found out throughout this exercise Since calculating the interest rate is a hurdle, I broke down the code into [interest rate](src/interestRate.ts) and [mortgage](src/mortgage.ts)-specific files. They contain all functions necessary to perform their respective responsibilities. I linked the sources of all formulas throughout the source code. -I'm writing tests and validating my outputs with the following calculators: +I'm writing tests and validating my outputs with the following calculators. Notice, however, that your mileage may vary because of rounding errors: - https://itools-ioutils.fcac-acfc.gc.ca/MC-CH/MCCalc-CHCalc-eng.aspx - https://www.mortgagecalculator.org/calcs/canadian.php + + ## Running the service You can run this project in three different ways. Spinning up a local server, invoking the function with mock data or deploying to AWS. However you choose, first, you must install the project's dependencies: