Skip to content

Commit 22b885e

Browse files
authored
Merge pull request #7 from wowinter13/feat/readme_upd
Add more badges and details to README.md
2 parents b05c8e3 + 479c5de commit 22b885e

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This package is a ruby native port of the numpy-financial package with some help
44

55
The functions in this package are a scalar version of their vectorised counterparts in the [numpy-financial](https://github.com/numpy/numpy-financial) library.
66

7-
[![Release](https://img.shields.io/github/v/release/wowinter13/finance_rb.svg?style=flat-square)](https://github.com/wowinter13/finance_rb/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
7+
[![Release](https://img.shields.io/github/v/release/wowinter13/finance_rb.svg?style=flat-square)](https://github.com/wowinter13/finance_rb/releases) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Maintainability](https://api.codeclimate.com/v1/badges/bbca82ad7815794c6718/maintainability)](https://codeclimate.com/github/wowinter13/finance_rb/maintainability)
88

99
Currently, only some functions are ported,
1010
which are as follows:
@@ -20,4 +20,32 @@ which are as follows:
2020
| rate | | Computes the rate of interest per period|
2121
| irr || Computes the internal rate of return|
2222
| npv || Computes the net present value of a series of cash flow|
23-
| mirr || Computes the modified internal rate of return|
23+
| mirr || Computes the modified internal rate of return|
24+
25+
## Installation
26+
27+
finance_rb is available as a gem, to install it just install the gem:
28+
29+
gem install finance_rb
30+
31+
If you're using Bundler, add the gem to Gemfile.
32+
33+
gem 'finance_rb'
34+
35+
Run `bundle install`.
36+
37+
## Running tests
38+
39+
bundle exec rspec spec/
40+
41+
## Contributing
42+
43+
1. Fork it ( https://github.com/wowinter13/finance_rb/fork )
44+
2. Create your feature branch (`git checkout -b my-new-feature`)
45+
3. Commit your changes (`git commit -am 'Add some feature'`)
46+
4. Push to the branch (`git push origin my-new-feature`)
47+
5. Create a new Pull Request
48+
49+
## License
50+
51+
MIT License. See LICENSE for details.

0 commit comments

Comments
 (0)