document: update readme and add document

MeilCli · Oct 20, 2022 · 53f8b88 · 53f8b88
1 parent 239f2a1
commit 53f8b88
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,14 @@ You can also pin to a [specific release](https://github.com/MeilCli/danger-actio
   - optional
   - version information with gem styled
   - default: `>= 6.0.0`
+- `danger_version_file`
+  - optional
+  - danger version file
+  - default: `.tool-versions`
+- `danger_version_file_format`
+  - optional
+  - danger version file format. [more detail](./docs/danger-version-file.md)
+  - default: `asdf`
 - `plugins_file`
   - optional
   - gemfile path for danger plugin. if set plugins_file, action do not exec `gem install danger`

diff --git a/docs/danger-version-file.md b/docs/danger-version-file.md
@@ -0,0 +1,9 @@
+# danger version file style
+Currently, support only asfd style
+
+## asfd
+`.tool-versions`:
+
+```
+danger 9.0.0
+```