From: glyn Date: Fri, 6 Jun 2014 13:53:32 +0000 (+0100) Subject: Format parameters section X-Git-Url: https://git.8kb.co.uk/?p=playtime%2Fmortgage_calculator;a=commitdiff_plain;h=45da4eeec6a81bdb451d06318e24f1ca06e18b9f;hp=8bb71868a84b00332b067afc5ab660fd7e692a80 Format parameters section --- diff --git a/README.md b/README.md index d8ebfac..f6ddd23 100644 --- a/README.md +++ b/README.md @@ -13,15 +13,15 @@ but can be used to estimate tracker types too. ##Parameters are: -mortgage_value *-m* Value of the mortgage (i.e. Property value minus Deposit) -arrangement_fee *-a* Any arrangement fee on the initial mortgage -interest_rate *-i* The rate in percent of the initial mortgage deal -interest_rate_term *-it* The term for the initial interest rate -term *-t* The total term of the mortgage (defaults to 25 years) -interest_rate_increase *-ii* A yearly increace for the interest rate outside of the initial fixed term -cap_rate_increase *-ic* Cap the yearly interest increase at a particular value -monthly_overpayment *-o* The value of any regular monthly overpayments you intend to make -monthly_payment *-p* An amount you decide you want to pay off each month (calculated from mortgage value, rate and term otherwise) +* mortgage_value *-m* Value of the mortgage (i.e. Property value minus Deposit) +* arrangement_fee *-a* Any arrangement fee on the initial mortgage +* interest_rate *-i* The rate in percent of the initial mortgage deal +* interest_rate_term *-it* The term for the initial interest rate +* term *-t* The total term of the mortgage (defaults to 25 years) +* interest_rate_increase *-ii* A yearly increace for the interest rate outside of the initial fixed term +* cap_rate_increase *-ic* Cap the yearly interest increase at a particular value +* monthly_overpayment *-o* The value of any regular monthly overpayments you intend to make +* monthly_payment *-p* An amount you decide you want to pay off each month (calculated from mortgage value, rate and term otherwise) ##Example usage