Contents

![Gem Version](https://img.shields.io/badge/finance_math-0.2-blue.svg)
![Build Status](https://img.shields.io/badge/build-passing-green.svg)


## What is FinanceMath?

FinanceMath is a Ruby library for mapping Exel functions. Due to lack such libraries to handle every day need, this library is created.

## Installation

FinanceMath is available as a gem, to install it just install the gem:

    gem install finance_math

If you're using Bundler, add the gem to Gemfile.

    gem 'finance_math'

Run `bundle install`.

## Basic Usage

Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan.

```ruby

Loan.new(10.5, 12, 15000)
```

## Functions 

This is the list of available functions.

## PMT

Calculates the periodic payment for an annuity investment based on constant-amount periodic payments and a constant interest rate.

```ruby

loan = Loan.new(10.5, 12, 15000)
loan.pmt
```

## Contributing

1. Fork it ( https://github.com/kolosek/finance_math/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Tests

Please cover with tests your pull requests

## License

MIT License. See LICENSE for details.

## Copyright

Copyright (c) 2014-2015 Nebojsa Zoric, and Kolosek, Inc. (http://kolosek.com)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
finance_math-0.0.1	README.md