README.md in cureutils-0.2.1 vs README.md in cureutils-1.0.0
- old
+ new
@@ -2,20 +2,33 @@
<img src="./img/cureutils_logo.png" />
</p>
# Cureutils
[](https://badge.fury.io/rb/cureutils)
+[](https://travis-ci.org/greymd/cureutils)
Useful command line tool for Japanese battle heroine Pretty Cure (Precure).
+
+
+## Requirements
+
+* ruby >= 2.2.2
+ + more: [.travis.yml](./.travis.yml)
+
## Installation
Install:
- $ gem install cureutils
+```
+$ gem install cureutils
+# for 2.2
+$ gem install 'backport_dig'
+```
+
After that, `cure` command is available.
$ cure
# Usage
@@ -59,19 +72,36 @@
And other general date formats are usable.
### Options
-| Option | Description |
-| ------ | --------- |
-| -d | cure date -d STRING: display time described by STRING |
+| Option | Description |
+| ------ | --------- |
+| -d | cure date -d STRING: display time described by STRING |
+| -f | cure date -f DATEFILE: Load each line of DATEFILE as STRING of -d option. |
```sh
$ cure date -d '3 years ago' '+%Y/%m @P'
2013/06 ドキドキ！プリキュア放映期間
```
+Standard input can be loaded by giving `-` as DATEFILE.
+
+```sh
+$ echo 2016{01..12}{01..31}| xargs -n 1 | cure date -f - '+%F @P' 2>/dev/null | grep 誕生日 | head
+2016-01-07 宇佐美いちか(キュアホイップ)誕生日/Go!プリンセスプリキュア放映期間
+2016-04-04 雪城ほのか(キュアホワイト)誕生日/魔法つかいプリキュア！放映期間
+2016-04-10 春野はるか(キュアフローラ)誕生日/魔法つかいプリキュア！放映期間
+2016-04-16 有栖川ひまり(キュアカスタード)誕生日/魔法つかいプリキュア！放映期間
+2016-05-28 四葉ありす(キュアロゼッタ)誕生日/魔法つかいプリキュア！放映期間
+2016-06-11 琴爪ゆかり(キュアマカロン)誕生日/魔法つかいプリキュア！放映期間
+2016-06-12 朝日奈みらい(キュアミラクル)誕生日/魔法つかいプリキュア！放映期間
+2016-07-20 海藤みなみ(キュアマーメイド)誕生日/魔法つかいプリキュア！放映期間
+2016-08-04 相田マナ(キュアハート)誕生日/魔法つかいプリキュア！放映期間
+2016-08-07 日向咲(キュアブルーム)誕生日/魔法つかいプリキュア！放映期間
+```
+
## `cure echo`
Print messages of Precure.
```
cure echo [OPTIONS] PATTERN
@@ -88,19 +118,27 @@
プリキュア・スマイルチャージ！
(ゴー！ゴー！レッツ・ゴー！ハッピー！！)
キラキラ輝く未来の光！ キュアハッピー！
5つの光が導く未来！
輝け！スマイルプリキュア！
+
+# Choose style for MAHO GIRLS PRECURE!
+$ cure echo -p cure_magical -s ruby
+キュアップ・ラパパ！ ルビー！
+ミラクル・マジカル・ジュエリーレ！
+ふたりの魔法！キュアマジカル！
+魔法つかいプリキュア！！
```
### Options
-| Option | Description |
-| ------ | ----------- |
-| -a | Print attack message. |
-| -q | Print messages immediately. |
-| -p | Print the given PRECURE's message. |
+| Option | Description |
+| ------ | ----------- |
+| -a | Print attack message. |
+| -q | Print messages immediately. |
+| -p | Print the given PRECURE's message. |
+| -s | Choose style of the transformation. |
## `cure girls`
Print girls' name.
@@ -119,11 +157,11 @@
...
```
| Option | Description |
| ------ | ----------- |
-| -v | Include particular girl's full name. |
+| -f | Show girl's full name if it exists. |
| -m | Include who have only appeared in the movies. |
## `cure grep`
@@ -244,12 +282,21 @@
## Zsh completion
[zsh-completion/_cure](zsh-completion/_cure) is the file for `cure` command completion.
With [zplug](https://github.com/zplug/zplug), it can be installed like this.
+
```sh
-zplug "greymd/cureutils", use:cureutils.plugin.zsh
+zplug "greymd/cureutils"
```
+
+And update like this.
+
+```sh
+$ zplug update greymd/cureutils
+```
+
+
## 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.