add README

oknowrun · May 19, 2020 · e06f9df · e06f9df
1 parent b7ac747
commit e06f9df
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# reviewdog caching action
+
+This action loads `reviewdog` into the GitHub Action tools-cache.
+
+## Inputs
+
+### `version`
+
+**Required** The version of reviewdog to load. Default `"latest"`.
+
+## Example usage
+
+```yaml
+uses: oknowrun/action-reviewdog@v1
+with:
+  version: 0.10.0
+```
diff --git a/index.js b/index.js
@@ -38,8 +38,6 @@ function getReleaseURL(version = "0.10.0") {
 }
 
 async function fetchReviewdog(version = "0.10.0") {
-  const releaseUrl = getReleaseURL(version);
-
   const reviewdogPath = await tc.downloadTool(getReleaseURL(version));
   const reviewdogExtractedFolder = await tc.extractTar(
     reviewdogPath,