README.md in finance_math-1.0.5 vs README.md in finance_math-1.0.6
- old
+ new
@@ -1,7 +1,6 @@
[![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?
@@ -28,51 +27,51 @@
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(nominal_rate: 10.5, duration: 12, amount: 15000)
+FinanceMath::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 structure_fee = 5, currency protection = 3, so please update if you need other values.
```ruby
-Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000, structure_fee: 5.1, currency_protection: 2.75, fee: 25)
+FinanceMath::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.
-### Loan.pmt
+### FinanceMath::Loan.pmt
Calculates the periodic payment for an annuity investment based on constant-amount periodic payments and a constant interest rate.
```ruby
-loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
+loan = FinanceMath::Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
loan.pmt
# 87.9158872300099
```
-### Loan.apr
+### FinanceMath::Loan.apr
Calculates the Annual Percentage Rate.
```ruby
-loan = Loan.new(nominal_rate: 13, duration: 12, amount: 10000)
+loan = FinanceMath::Loan.new(nominal_rate: 13, duration: 12, amount: 10000)
loan.apr
#29.179538647635006
-loan = Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10)
+loan = FinanceMath::Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10)
loan.apr
#23.964418264624054
```
@@ -88,21 +87,21 @@
Please cover with tests your pull requests
## Ruby versions
- Currently supported up to 2.4.1
+ Currently supported version of 2.x and 3.x
## Credits
Finance Math is maintained and sponsored by
[Kolosek] (http://kolosek.com).
![Kolosek](http://kolosek.com/logo.png)
-Initially developed by Nebojsa Zoric
+Initially developed by Nesha Zoric
-###Follow up @nebojsaz and @kolosek
+###Follow up @kolosek
## License
MIT License. See LICENSE for details.