README.md in cureutils-0.1.0 vs README.md in cureutils-0.1.1
- old
+ new
@@ -1,40 +1,198 @@
+<p align="center">
+<img src="./img/cureutils_logo.png" />
+</p>
+
# Cureutils
-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/cureutils`. To experiment with that code, run `bin/console` for an interactive prompt.
+Useful command line tool for Japanese battle heroine "Pretty Cure (Precure)".
-TODO: Delete this and the text above, and describe your gem
-
## Installation
-Add this line to your application's Gemfile:
+Install it yourself as:
-```ruby
-gem 'cureutils'
+ $ gem install cureutils
+
+
+After that, `cure` command is availabe.
+
+ $ cure
+
+## Usage
+
+### cure date
+Display date, time and Precure related events.
+
+```sh
+$ cure date
+2016-06-17 21:28:42 魔法つかいプリキュア！放映期間
```
-And then execute:
+* %Y : Year
+* %m : Month 01 - 12
+* %d : Date 01 - 31
+* @P : Precure related events.
+* And other general date formats are usable.
- $ bundle
+#### Options
-Or install it yourself as:
+| Option | Description |
+| ------ | --------- |
+| -d | cure date -d STRING: display time described by STRING |
- $ gem install cureutils
-## Usage
+```sh
+$ cure date -d '3 years ago' '+%Y/%m @P'
+2013/06 ドキドキ！プリキュア放映期間
+```
-TODO: Write usage instructions here
-## Development
+### cure echo
+Print messages of Precure.
-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.
+```sh
+$ cure echo
+みんなの思いを守るために
+心をひとつに！
+思いよ届け！キュアエコー！
+```
-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).
+### cure girls
+Print girls' name
-## Contributing
+```sh
+$ cure girls
+美墨なぎさ
+雪城ほのか
+九条ひかり
+日向咲
+美翔舞
+夢原のぞみ
+夏木りん
+春日野うらら
+秋元こまち
+水無月かれん
+...
+```
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cureutils. 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.
+### cure grep
+Print lines matching a pattern.
+```sh
+$ echo キュア{レッド,ピンク,ブラック,ブルー,ホワイト}"\n" | cure grep
+ キュアブラック
+ キュアホワイト
+```
+
+#### Options
+
+| Option | Description |
+| ------ | ----------- |
+| -E | Interpret PATTERN as an extended regular expression. |
+| -o | Print only the matched (non-empty) parts of a matching line, with each such part on a separate out. |
+
+
+#### Folloing "Precure bracket expression" are available.
+
+| Expression | Description |
+| ---------- | -------------- |
+| [:cast_name:] | Voice actor name. |
+| [:color:] | Name of the color of the Precure. |
+| [:girl_name:] | Girl name. |
+| [:human_name:] | Real name before transforming. |
+| [:precure_name:] | Precure name. |
+
+
+```sh
+$ cat txt | cure grep '私は[:precure_name:]です。'
+こんにちは、 私はキュアレモネードです。
+```
+
+### cure tr
+Translate Precure related parameters.
+
+```sh
+$ echo 相田マナ | cure tr '[:human_name:]' '[:cast_name:]'
+生天目仁美
+```
+
+#### Folloing "Precure bracket expression" are available.
+
+| Expression | Description |
+| ---------- | -------------- |
+| [:cast_name:] | Voice actor name. |
+| [:color:] | Name of the color of the Precure. |
+| [:girl_name:] | Girl name. |
+| [:human_name:] | Real name before transforming. |
+| [:precure_name:] | Precure name. |
+
+
+### cure transform
+Replace human_name to precure_name
+
+```sh
+$ echo '私の名前は十六夜リコです。' | cure transform
+私の名前はキュアマジカルです。
+```
+
+### cure humanize
+Change precure_name to human_name.
+
+```sh
+$ echo キュア{ハート,エース} | cure humanize
+相田マナ 円亜久里
+```
+
+### cure janken
+Let's play "Pikarin Janken" !
+
+```sh
+$ cure janken
+ピカピカピカリン
+ジャンケンポン！
+1...グー, 2...チョキ, 3...パー : 1
+
+あなた: グー
+キュアピース: グー
+
+[結果]
+あいこ
+```
+
+Exit status is changed depending on the result.
+
+| Result | Exit status |
+| ------ | ----------- |
+| You win | 0 |
+| You lose | 1 |
+| Draw | 2 |
+
+### cure precures
+Print Precure names
+
+```
+$ cure precures
+キュアブラック
+キュアホワイト
+シャイニールミナス
+キュアブルーム
+キュアイーグレット
+キュアブライト
+キュアウィンディ
+キュアドリーム
+キュアルージュ
+キュアレモネード
+...
+```
+
+## Zsh completion
+
+[etc/cure-completion.zsh](etc/cure-completion.zsh) is useful if you are using Zsh.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/greymd/cureutils. 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).