Add description for 'title' input

c-bata · Jan 28, 2020 · 7e7e555 · 7e7e555
1 parent a4bd321
commit 7e7e555
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -15,6 +15,10 @@ See [github-actions-kurobako/plot](./plot) action to generate a plot image.
 
 **Required**  A public image url to kurobako plot image.
 
+### `title`
+
+**Optional** A text for the title.
+
 ## Outputs
 
 There is no output values.
@@ -27,6 +31,7 @@ uses: c-bata/github-actions-kurobako@master
 with:
   report-md-path: './kurobako-report.md'
   public-image-url: 'https://example.com/public-image-url.png'
+  text: 'Benchmark of quadratic function'
 ```
 
 ## License

diff --git a/action.yml b/action.yml
@@ -10,7 +10,7 @@ inputs:
     required: true
     default: 'https://storage.googleapis.com/kurobako-reports/dummy.png'
   title:
-    description: 'A title text for the top of header'
+    description: 'A text for the title'
     required: false
     default: 'Kurobako benchmark'
 outputs: