README.md in fiscal_year-0.2.0 vs README.md in fiscal_year-0.3.0
- old
+ new
@@ -1,13 +1,17 @@
-
+
+[](https://badge.fury.io/rb/fiscal_year)
[](https://codeclimate.com/github/TsubasaKawajiri/fiscal_year/maintainability)
[](https://codeclimate.com/github/TsubasaKawajiri/fiscal_year/test_coverage)
# FiscalYear
-Calculate fiscal year half, quarter, and year to date.
+FiscalYear is calculates half-year, quarter-year, and YTD figures.
+It can take in a year's numerical value or a year and month and return the results as a Range.
+Additionally, it allows for the customization of the starting month of the fiscal period.
+
## Installation
```
gem 'fiscal_year'
```
@@ -52,10 +56,10 @@
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/TsubasaKawajiri/fiscal_year. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/TsubasaKawajiri/fiscal_year/blob/master/CODE_OF_CONDUCT.md).