README.md in zakuro-0.0.1 vs README.md in zakuro-0.0.2
- old
+ new
@@ -2,19 +2,19 @@
zakuro は日本の暦を扱う暦算ライブラリです。
# 前掲
石榴（ざくろ）は古来より珍重され、シルクロードを通じて洋の東西に広く伝播した落葉小高木です。
-すなわち、中華世界においては太陰太陽暦、地中海世界においては太陽暦のもとで育ち、これら東西の暦はシルクロードの東端たる日本に深い影響を与えております。
+すなわち、中華世界においては `太陰太陽暦` 、地中海世界においては `太陽暦` のもとで育ち、これら東西の暦はシルクロードの東端たる日本に深い影響を与えております。
日本の暦は中国に端を発しますが、江戸時代以降は西洋の文物からも深く学び、日本人は暦算を自らのものとしました。
石榴はただ伝来しただけでなく、日本の地に根づいております。これを日本の暦になぞらえ、和名の「ざくろ」を冠することと致します。
## 導入
-Add this line to your application's Gemfile:
+[rubygem](https://rubygems.org/gems/zakuro) に登録しております。
```ruby
gem 'zakuro'
```
@@ -54,44 +54,77 @@
merchant.offer(condition: { date: western_date })
puts merchant.commit.to_json
# => {"year":{"first_gengou":{"name":"貞享","number":1},"second_gengou":{"name":"","number":-1},"zodiac_name":"甲子","total_days":354},"month":{"number":12,"leaped":false,"days_name":"大","first_day":{"number":1,"zodiac_name":"壬辰","remainder":"28-4182","western_date":"1685-01-05"},"odd_solar_terms":[{"index":1,"remainder":"30-890"}],"even_solar_terms":[{"index":2,"remainder":"45-2726"}]},"day":{"number":30,"zodiac_name":"辛酉","remainder":"57-4182","western_date":"1685-02-03"}}
```
-# 期待値
-『日本暦日原典』を範とします。
+# 条件
-|項目|-|-|参考値|備考|
+条件（condition）のバリエーションを示します。
+
+|項目名|キー名|hash内キー名|データ型|備考|
|:----|:----|:----|:----|:----|
-|year|first_gengou|name|貞観|年号|
-| | |number|4|年号年|
-| |second_gengou|name| |年号（南北朝時代の北朝）|
-| | |number|-|年号年|
-| |zodiac_name| |壬午|年の干支|
-| |total_days| |354|年の日数|
-|month|number| |1|x月|
-| |leaped| |false|閏月（true）/平月（false）|
-| |days_name| |大|月の大小（30日/29日）|
-| |first_day|number|1|x日（1日固定）|
-| | |zodiac_name|庚午|日の干支|
-| | |remainder|6-1282|大余小余|
-| | |western_date|0862-02-03|西暦日|
-| |odd_solar_terms|index|5|節気（番号） ※冬至=0|
-| | |remainder|34-5368|大余小余|
-| |even_solar_terms|index|4|中気（番号） ※冬至=0|
-| | |remainder|19-3532|大余小余|
-|day|number| |1|x日|
-| |zodiac_name| |庚午|日の干支|
-| |remainder| |6-1282|大余小余|
-| |western_date| |0862-02-03|西暦日|
+|基準日|date| |Date| 西暦日 |
+| | | |String| 和暦日 |
+|範囲（開始日）|range|start|Date| |
+|範囲（終了日）| |last|Date| |
+|列|columns| |Array<String>|取得したい列の列名|
+|オプション|options| |Array<String>|取得オプション|
+現時点では `date` の西暦日のみ対応中です。
+
+## オプション
+
+|項目名|キー名|データ型|データ|備考|
+|:----|:----|:----|:----|:----|
+|単位|unit|String|year|年単位|
+| | | |month|月単位|
+| | | |day|日単位（デフォルト）|
+|没日|lost_days|True| |没日あり|
+| | |False| |没日なし（デフォルト）|
+|四季|seasons|True| |四季あり|
+| | |False| |四季なし（デフォルト）|
+
+# 期待値
+暦算値は『日本暦日原典』、元号の切り替えは『日本史年表 第5版』を範とします。
+
+|項目名|キー名|-|-|参考値|備考|
+|:----|:----|:----|:----|:----|:----|
+|年号|year|first_gengou|name|貞観| |
+|年号年| | |number|4| |
+|年号（南北朝時代の北朝）| |second_gengou|name| |南北朝時代の北朝のみ|
+|年号年| | |number|-|南北朝時代の北朝のみ|
+|年の干支| |zodiac_name| |壬午| |
+|年の日数| |total_days| |354| |
+|月|month|number| |1|x月|
+|閏月判定| |leaped| |false|閏月（true）/平月（false）|
+|月の大小| |days_name| |大|大（30日） / 小（29日）|
+|月初日| |first_day|number|1|x日（1日固定）|
+|月初日の干支| | |zodiac_name|庚午| |
+|月初日の大余小余| | |remainder|6-1282| |
+|西暦日| | |western_date|0862-02-03| |
+|節気| |odd_solar_terms|index|5|番号（冬至0始まり）|
+|節気の大余小余| | |remainder|34-5368|大余小余|
+|中気| |even_solar_terms|index|4|番号（冬至0始まり）|
+|中気の大余小余| | |remainder|19-3532|大余小余|
+|日|day|number| |1|x日|
+|日の干支| |zodiac_name| |庚午|日の干支|
+|日の大余小余| |remainder| |6-1282|大余小余|
+|西暦日| |western_date| |0862-02-03|西暦日|
+
+# 元号
+
+[一覧](./doc/gengou.md) を参照してください。
+
# 暦算
[宣明暦](./lib/zakuro/version/senmyou/README.md) のみ記載しております。
-## Contributing
+## コントリビュート（Contributing）
-Bug reports and pull requests are welcome on GitHub at https://github.com/pldb/zakuro.
+バグ報告/修正はこちらまで。
+https://github.com/pldb/zakuro
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## ライセンス
+
+gem は [MIT License](https://opensource.org/licenses/MIT) の条件の下、オープンソースとして利用可能です。