Merge pull request #35 from koki-develop/update-docs

README.ja.md

@@ -71,8 +71,11 @@ func main() {
 
 ![](./examples/basic/demo.gif)
 
-詳しい情報は[ドキュメント](./docs/library/README.ja.md)をご参照ください。  
-また、 [examples](./examples/) には go-fzf の使い方の様々なサンプルが用意されています。
+詳しい情報は[ドキュメント](./docs/library/README.ja.md)をご参照ください。
+
+#### 使用例
+
+[examples](./examples/) には go-fzf の使い方の様々な例が用意されています。
 
 ## ライセンス
 

README.md

@@ -71,8 +71,11 @@ func main() {
 
 ![](./examples/basic/demo.gif)
 
-For more information, please refer to the [documentation](./docs/library/README.md)  
-Additionally, various samples of how to use go-fzf are available in the [examples](./examples/) directory.
+For more information, please refer to the [documentation](./docs/library/README.md)
+
+#### Examples
+
+Various examples of how to use go-fzf are available in the [examples](./examples/) directory.
 
 ## LICENSE
 

examples/README.ja.md

@@ -0,0 +1,92 @@
+# Examples
+
+[English](./README.md) | 日本語
+
+- [基本](#基本)
+- [複数選択](#複数選択)
+- [大文字 / 小文字を区別する](#大文字--小文字を区別する)
+- [キーマップ](#キーマップ)
+- [ホットリロード](#ホットリロード)
+- [見た目をカスタマイズする](#見た目をカスタマイズする)
+
+## 基本
+
+[Example](./basic/)
+
+![](./basic/demo.gif)
+
+## 複数選択
+
+[Example](./multiple/)
+
+![](./multiple/demo.gif)
+
+## 大文字 / 小文字を区別する
+
+[Example](./case-sensitive/)
+
+![](./case-sensitive/demo.gif)
+
+## キーマップ
+
+[Example](./keymap/)
+
+![](./keymap/demo.gif)
+
+## ホットリロード
+
+[Example](./hotreload/)
+
+![](./hotreload/demo.gif)
+
+## 見た目をカスタマイズする
+
+- [プロンプト](#プロンプト)
+- [カーソル](#カーソル)
+- [選択中 / 未選択アイテムの接頭辞](#選択中--未選択アイテムの接頭辞)
+- [インプットの位置](#インプットの位置)
+- [インプットのプレースホルダ](#インプットのプレースホルダ)
+- [カウントビュー](#カウントビュー)
+- [スタイル](#スタイル)
+
+### プロンプト
+
+[Example](./prompt/)
+
+![](./prompt/demo.gif)
+
+### カーソル
+
+[Example](./cursor/)
+
+![](./cursor/demo.gif)
+
+### 選択中 / 未選択アイテムの接頭辞
+
+[Example](./prefix/)
+
+![](./prefix/demo.gif)
+
+### インプットの位置
+
+[Example](./input-position/)
+
+![](./input-position/demo.gif)
+
+### インプットのプレースホルダ
+
+[Example](./placeholder/)
+
+![](./placeholder/demo.gif)
+
+### カウントビュー
+
+[Example](./countview/)
+
+![](./countview/demo.gif)
+
+### スタイル
+
+[Example](./styles/)
+
+![](./styles/demo.gif)

examples/README.md

@@ -0,0 +1,92 @@
+# Examples
+
+English | [日本語](./README.ja.md)
+
+- [Basic](#basic)
+- [Select Multiple](#select-multiple)
+- [Case Sensitive/Insensitive](#case-sensitiveinsensitive)
+- [Key Mapping](#key-mapping)
+- [Hot Reload](#hot-reload)
+- [Customize UI](#customize-ui)
+
+## Basic
+
+[Example](./basic/)
+
+![](./basic/demo.gif)
+
+## Select Multiple
+
+[Example](./multiple/)
+
+![](./multiple/demo.gif)
+
+## Case Sensitive/Insensitive
+
+[Example](./case-sensitive/)
+
+![](./case-sensitive/demo.gif)
+
+## Key Mapping
+
+[Example](./keymap/)
+
+![](./keymap/demo.gif)
+
+## Hot Reload
+
+[Example](./hotreload/)
+
+![](./hotreload/demo.gif)
+
+## Customize UI
+
+- [Prompt](#prompt)
+- [Cursor](#cursor)
+- [Prefix of selected/unselected items](#prefix-of-selectedunselected-items)
+- [Position of input](#position-of-input)
+- [Placeholder for input](#placeholder-for-input)
+- [Count View](#count-view)
+- [Styles](#styles)
+
+### Prompt
+
+[Example](./prompt/)
+
+![](./prompt/demo.gif)
+
+### Cursor
+
+[Example](./cursor/)
+
+![](./cursor/demo.gif)
+
+### Prefix of selected/unselected items
+
+[Example](./prefix/)
+
+![](./prefix/demo.gif)
+
+### Position of input
+
+[Example](./input-position/)
+
+![](./input-position/demo.gif)
+
+### Placeholder for input
+
+[Example](./placeholder/)
+
+![](./placeholder/demo.gif)
+
+### Count View
+
+[Example](./countview/)
+
+![](./countview/demo.gif)
+
+### Styles
+
+[Example](./styles/)
+
+![](./styles/demo.gif)