README.md in wilksformula-0.0.1 vs README.md in wilksformula-0.0.2
- old
+ new
@@ -1,8 +1,8 @@
# Wilksformula
-TODO: Write a gem description
+Gem to calculate the Wilks formula
## Installation
Add this line to your application's Gemfile:
@@ -16,14 +16,20 @@
$ gem install wilksformula
## Usage
-TODO: Write usage instructions here
+Wilksformula.men_formula(weight,total)
+Wilksformula.women_formula(weight,total)
+
+## Example
+
+Wilksformula.men_formula(60,600) # 511.74
+
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/wilksformula/fork )
+1. Fork it ( http://github.com/masayukioguni/wilksformula/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 new Pull Request