README.md in japanese_calendar-0.1.0 vs README.md in japanese_calendar-0.1.1
- old
+ new
@@ -1,11 +1,9 @@
-# JapaneseCalendar
+# Japanese Calendar [](https://badge.fury.io/rb/japanese_calendar) [](https://travis-ci.org/RyoYamamotoJP/japanese_calendar) [](https://codeclimate.com/github/RyoYamamotoJP/japanese_calendar) [](https://codeclimate.com/github/RyoYamamotoJP/japanese_calendar/coverage)
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/japanese_calendar`. To experiment with that code, run `bin/console` for an interactive prompt.
+Japanese calendar utility for Ruby.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,22 +18,37 @@
$ gem install japanese_calendar
## Usage
-TODO: Write usage instructions here
+To get the Japanese era name, use the `era_name` method:
+```
+Time.new(1989, 1, 8).era_name # => "平成"
+Time.new(1926, 12, 25).era_name # => "昭和"
+Time.new(1912, 7, 30).era_name # => "大正"
+Time.new(1868, 1, 25).era_name # => "明治"
+```
+
+You can convert to a Japanese year with the `era_year` method:
+
+```
+Time.new(2016, 12, 11).era_year # => 28
+Time.new(1989, 1, 7).era_year # => 64
+Time.new(1926, 12, 24).era_year # => 15
+Time.new(1912, 7, 29).era_year # => 45
+```
+
## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/japanese_calendar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/RyoYamamotoJP/japanese_calendar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-