From 1b64bc3d753a87a269e7c836a262fa172b89b52a Mon Sep 17 00:00:00 2001
From: Katsuya Hidaka <hidakatsuya@gmail.com>
Date: Thu, 15 Apr 2021 03:13:17 +0900
Subject: [PATCH] Update README

---
 README.md | 114 +++++++-----------------------------------------------
 1 file changed, 15 insertions(+), 99 deletions(-)

diff --git a/README.md b/README.md
index 0c39e55..20774fc 100644
--- a/README.md
+++ b/README.md
@@ -4,114 +4,30 @@ GitHub Action to install [diff-pdf](https://github.com/vslavik/diff-pdf).
 
 [![Test this action](https://github.com/hidakatsuya/setup-diff-pdf/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/hidakatsuya/setup-diff-pdf/actions/workflows/test.yml?query=branch%3Amain)
 
+## Usage
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
-
-This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
-
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
-
-## Create an action from this template
-
-Click the `Use this Template` and provide the new repo details for your action
-
-## Code in Main
-
-Install the dependencies
-
-```bash
-npm install
-```
-
-Run the tests :heavy_check_mark:
-
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-...
-```
-
-## Change action.yml
-
-The action.yml defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-const core = require('@actions/core');
-...
-
-async function run() {
-  try {
-      ...
-  }
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
+```yaml
+- uses: hidakatsuya/setup-diff-pdf@v1
+  with:
+    diff-pdf-version: 0.5
 ```
 
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Package for distribution
-
-GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
+For the version of `diff-pdf` that can be specified, see [the diff-pdf releases](https://github.com/vslavik/diff-pdf/releases).
 
-Actions are run from GitHub repos.  Packaging the action will create a packaged action in the dist folder.
+## Supported Platforms
 
-Run prepare
-
-```bash
-npm run prepare
-```
-
-Since the packaged index.js is run from the dist folder.
-
-```bash
-git add dist
-```
+- ubuntu-latest
+- windows-latest
 
-## Create a release branch
+See [GitHub Docs](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#github-hosted-runners) for more information.
 
-Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
+## Versioning
 
-Checkin to the v1 release branch
+This action follows [the recommendations of GitHub Actions Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md).
 
-```bash
-git checkout -b v1
-git commit -a -m "v1 release"
-```
+## Building this action
 
-```bash
-git push origin v1
 ```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket:
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Usage
-
-You can now consume the action by referencing the v1 branch
-
-```yaml
-uses: actions/javascript-action@v1
-with:
-  milliseconds: 1000
+$ yarn
+$ yarn run package
 ```
-
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket: