fix readme (#100)

Co-authored-by: masaya.suzuki <suzukimasaya428@gmail.com>

Author: Goryudyuma

README.md

@@ -1,10 +1,54 @@
 # actions-diff-pr-management
 
-diffを元にPRを作成するGitHub ActionsのWorkflowです。
+PRのブランチに対して、フォーマッタによって修正された結果を、PRにするGitHub Actionsです。
+
+本Actionsを使わずにフォーマットを修正した場合、自動的にPRを閉じます。
+
+## 注意点
+
+元のPRを閉じた場合、本Actionsが立てたPRは残ります。  
+このような場合、 <https://github.com/dev-hato/actions-close-pr> を併用することで自動的にPRを閉じることができます。
+
+## 使い方
+
+```yaml
+on:
+  pull_request:
+
+jobs:
+  diff-pr-management:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      - run: hoge fmt # FIXME フォーマッタを走らせる
+      - uses: dev-hato/actions-diff-pr-management@v1
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          repo-name: ${{ github.event.pull_request.head.repo.full_name }}
+```
+
+## 例
+
+* 元のPR: <https://github.com/dev-hato/actions-diff-pr-management/pull/96>
+* 本Actionsによって作成されたPR: <https://github.com/dev-hato/actions-diff-pr-management/pull/98>
+
+## 引数
+
+|          引数名          |                           説明                            | 必須  |
+|:---------------------:|:-------------------------------------------------------:|:---:|
+|     github-token      |                      GitHubのトークン。                       |  O  |
+|       repo-name       | リポジトリ名。 `pull_request` 以外のトリガーも設定している場合はリポジトリ名を決め打ちで入力。 |  O  |
+|  branch-name-prefix   |                      branch名の接頭語。                       |     |
+|    pr-title-prefix    |                      PRのタイトルの接頭語。                       |     |
+| pr-description-prefix |                         本文の接頭語。                         |     |
 
 ## 開発
 
 ### 設定
 
-<https://pre-commit.com/> の手順に従って `pre-commit` をインストールする。  
-これにより、[.pre-commit-config.yaml](.pre-commit-config.yaml)の設定に基づいて、コミット時にクレデンシャルが含まれていないかの検査が行われるようになる。
+<https://pre-commit.com/> の手順に従って `pre-commit` をインストールします。  
+これにより、コミット時にクレデンシャルが含まれていないかの検査が行われるようになります。

action.yml

@@ -8,12 +8,15 @@ inputs:
   branch-name-prefix:
     description: 'Prefix of PR branch name'
     required: true
+    default: fix
   pr-title-prefix:
     description: 'Prefix of PR title'
     required: true
+    default: fix
   pr-description-prefix:
     description: 'Prefix of PR description'
     required: true
+    default: ""
   repo-name:
     description: 'Repository name'
     required: true