README.md in finance_math-1.0.1 vs README.md in finance_math-1.0.2

- old
+ new

@@ -1,6 +1,6 @@ -![Gem Version](https://img.shields.io/badge/finance_math-1.0-blue.svg) +[![Gem Version](https://badge.fury.io/rb/finance_math.svg)](http://badge.fury.io/rb/finance_math) [![Build Status](https://semaphoreapp.com/api/v1/projects/869d7630-55d3-46e5-9dc2-03d0d1cfecfe/363108/shields_badge.svg)](https://semaphoreapp.com/kolosek/finance_math) [![Code Climate](https://codeclimate.com/github/kolosek/finance_math/badges/gpa.svg)](https://codeclimate.com/github/kolosek/finance_math) ## What is FinanceMath? @@ -20,25 +20,26 @@ Run `bundle install`. ## Basic Usage Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan. +Defaults are structure_fee = 5, currency protection = 3, so please update if you need other values. ```ruby -Loan.new(10.5, 12, 15000) +Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000) ``` ## Advanced Usage Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan, and additional values such as bank fee, currency protection, and fee for each monthly payment. -Defaults are bank fee = 5, currency protection = 3, so please update if you need other values. +Defaults are structure_fee = 5, currency protection = 3, so please update if you need other values. ```ruby -Loan.new(10.5, 12, 15000, 5.1, 2.75, 25) +Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000, structure_fee: 5.1, currency_protection: 2.75, fee: 25) ``` ## Functions This is the list of available functions. @@ -47,11 +48,11 @@ Calculates the periodic payment for an annuity investment based on constant-amount periodic payments and a constant interest rate. ```ruby -loan = Loan.new(10, 12, 1000) +loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000) loan.pmt # 87.9158872300099 ``` @@ -59,14 +60,14 @@ Calculates the Annual Percentage Rate. ```ruby -loan = Loan.new(13, 12, 10000) +loan = Loan.new(nominal_rate: 13, duration: 12, amount: 10000) loan.apr #29.179538647635006 -loan = Loan.new(15, 36, 10000, 5, 3, 10) +loan = Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10) loan.apr #23.964418264624054 ```