Merge pull request #8 from tsshogi/feature/docs

docs: update README.md

README.md

@@ -1,11 +1,36 @@
-## Shogi Kif Parser
+## Kanna
 
 独自形式で配布されている棋譜データをtsshogiのRecord型に変換するためのライブラリです.
 
 ### 対応データ
 
 - [x] 詰将棋パラダイス
 
+### 導入
+
+GitHub Package Registryを利用しているので`.npmrc`または`npm login`が必要になります
+
+```zsh
+# .npmrc
+registry=https://npm.pkg.github.com/tsshogi
+```
+
+インストールは以下のコマンドをご利用ください
+
+```zsh
+# npm
+npm install @tsshogi/kanna
+
+# yarn
+yarn add @tsshogi/kanna
+
+# pnpm
+pnpm install @tsshogi/kanna
+
+# bun
+bun add @tsshogi/kanna
+```
+
 ### 使い方
 
 ```ts
@@ -18,10 +43,52 @@ if (record instanceof Error) return
 exportKIF(record) // KIF形式の文字列
 ```
 
-### 参考
+この結果、以下のようなレスポンスが得られます
+
+```zsh
+表題：ﾁｮｺﾏｶ銀
+作者：須藤大輔
+発表誌：詰将棋パラダイス
+発表年月：2010/07/21
+レベル：6
+ポイント：20
+ヒント：ﾁｮｺﾏｶ銀
+手数：11
+作品名：詰将棋パラダイス
+作品番号：99
+後手の持駒：歩十八　香四　桂二　銀二　金三　角　飛二　
+  ９ ８ ７ ６ ５ ４ ３ ２ １
++---------------------------+
+| ・ ・ ・ ・ ・ ・ ・ ・ ・|一
+| ・ ・ ・ ・ ・ ・ ・ ・ ・|二
+| ・ ・ ・ ・ ・ ・ ・ ・ ・|三
+| ・ ・ ・ ・ ・ ・ 馬 銀v玉|四
+| ・ ・ ・ ・ ・ ・v金 ・v銀|五
+| ・ ・ ・ ・ ・ ・ 桂 ・ ・|六
+| ・ ・ ・ ・ ・ ・ ・ ・ ・|七
+| ・ ・ ・ ・ ・ ・ ・ ・ ・|八
+| ・ ・ ・ ・ ・ ・ ・ ・ ・|九
++---------------------------+
+先手の持駒：桂　
+先手番
+手数----指手---------消費時間--
+```
+
+> 指し手も出力されますが、ネタバレ防止のためにここでは記載していません
+
+複数の詰み手順がある場合、それら全てを出力します。
+
+KIF形式以外の出力をした場合、カスタムメタデータは失われてしまいます。
+
+### 既知の問題
+
+- 盤面情報が正しくないデータに対してパースが失敗してしまう
+  - 問題番号58など
+
+## 参考
 
 - [tsshogi](https://github.com/sunfish-shogi/tsshogi)
 
-### ライセンス
+## ライセンス
 
 [MIT License](https://github.com/tsshogi/kanna/blob/main/LICENSE)