README.md in zakuro-0.9.4 vs README.md in zakuro-1.0.0
- old
+ new
@@ -1,5 +1,7 @@
+
+
# Zakuro - 石榴
zakuro は日本の暦を扱う暦算ライブラリです。
# 前掲
石榴（ざくろ）は古来より珍重され、シルクロードを通じて洋の東西に広く伝播した落葉小高木です。
@@ -8,20 +10,48 @@
日本の暦は中国に端を発しますが、江戸時代以降は西洋の文物からも深く学び、日本人は暦算を自らのものとしました。
石榴はただ伝来しただけでなく、日本の地に根づいております。これを日本の暦になぞらえ、和名の「ざくろ」を冠することと致します。
-## 導入
+# 有用性
-### Ruby
+下記3資料を用いた和暦日(没日・滅日あり)の特定を一度の検索で可能とします。
-次の範囲で動作確認しております。
+1. 『日本暦日原典〔第四版〕』
+2. 『日本暦日便覧』第四章 没日と滅日
+3. 『日本史年表 第5版』
-`2.6.x - 3.0.x`
+上記資料を用いる場合は、西暦年月日から1、2の該当のページを引き当てます。
-### Gem
+ただし、元号年表記のため、正確な元号は3の元号年月日を参照する必要があります。
+本ライブラリはこの手順をスキップし、直接、暦算値つきの和暦日を結果とします。
+
+さらに、和暦日からの西暦日検索も併せて可能とします。
+
+[日本の暦日データベース](https://eco.mtk.nao.ac.jp/cgi-bin/koyomi/caldb.cgi) に近しい機能を持ちますが、
+
+暦算値や没日・滅日を併せて結果出力する点が異なります。
+
+# 導入
+
+## Ruby
+
+Rubyの推奨バージョンは次の範囲とします。
+
+`2.6.x - 3.3.x`
+
+当ライブラリのバージョンが `1.0.0` の時点では、下記バージョンで動作確認を実施しております。
+* 2.6.3
+* 2.7.6
+* 3.0.6
+* 3.1.4
+* 3.2.2
+* 3.3.0-preview1
+
+## Gem
+
[rubygem](https://rubygems.org/gems/zakuro) に登録しております。
```ruby
gem 'zakuro'
```
@@ -38,11 +68,11 @@
開発途中です。
1日検索/期間検索に対応しております。
-下記表で暦算ありの暦は使用可能です。
+バージョンが `1.0.0` の時点では、下記表で暦算ありの暦が使用可能です。
|開始日|暦 |計算方法|暦算|没日|滅日|
|:----|:----|:----|:---|:---|:---|
|445/01/24|元嘉暦| |✓|-|-|
|698/02/16|儀鳳暦|A|✓|-|-|
@@ -60,12 +90,10 @@
表中A-Cは月の運動の計算手順ごとに分類されます。
現在は「長慶宣明暦算法」の計算手順Aのみ対応しております。
-「没日」「滅日」は計算できますが、正誤を確認中です。
-
# 使用方法
[使用方法](./doc/usage.md) を参照してください。
# 条件
@@ -119,9 +147,14 @@
## コントリビュート（Contributing）
バグ報告/修正はこちらまで。
https://github.com/pldb/zakuro
+
+## ロゴ・バナー
+
+* 制作: [migut.t](https://www.instagram.com/migut.t/#)
+* 調整: [pldb](https://github.com/pldb)
## ライセンス
gem は [MIT License](https://opensource.org/licenses/MIT) の条件の下、オープンソースとして利用可能です。