README.md in finance_math-1.0.2 vs README.md in finance_math-1.0.5
- old
+ new
@@ -3,11 +3,11 @@
[](https://codeclimate.com/github/kolosek/finance_math)
## What is FinanceMath?
-FinanceMath is a Ruby library for mapping Loan based Exel functions. It deals with problem of calculating the PMT and APR functions. It implements advanced usage, taking into account bank fees, fee for for each payment and currency protection (if currency other than $ USD). Highly precise with high speed of execution.
+FinanceMath is a Ruby library for mapping Loan based Exel functions. It deals with problem of calculating the PMT and APR functions. It implements advanced usage, taking into account bank fees, fee for for each payment and currency protection (if currency other than $ USD). Highly precise with high speed of execution.
## Installation
FinanceMath is available as a gem, to install it just install the gem:
@@ -17,10 +17,14 @@
gem 'finance_math'
Run `bundle install`.
+## Running tests
+
+ bundle exec rspec spec/
+
## 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.
@@ -29,20 +33,20 @@
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.
+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)
```
-## Functions
+## Functions
This is the list of available functions.
### Loan.pmt
@@ -82,12 +86,21 @@
## Tests
Please cover with tests your pull requests
-## Copyright
+## Ruby versions
-Copyright (c) 2014-2015 Nebojsa Zoric, and Kolosek, Inc. (http://kolosek.com)
+ Currently supported up to 2.4.1
+
+## Credits
+
+Finance Math is maintained and sponsored by
+[Kolosek] (http://kolosek.com).
+
+
+
+Initially developed by Nebojsa Zoric
###Follow up @nebojsaz and @kolosek
## License