From 55bcb00b352c7a2581c88d113c178ca0a3885042 Mon Sep 17 00:00:00 2001 From: khai96_ Date: Fri, 8 May 2020 14:44:30 +0700 Subject: [PATCH] Create README.md --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..00c8bf8 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Setup PNPM + +Install PNPM package manager. + +## Inputs + +### `version` + +**Required** Version of PNPM to install. + +### `dest` + +**Optional** Where to store PNPM files. + +### `bin_dest` + +**Optional** Where to store executables (`pnpm` and `pnpx` commands). + +### `registry` + +**Optional** Registry to download PNPM from. + +## Outputs + +### `dest` + +Expanded path of inputs#dest. + +### `bin_dest` + +Expanded path of inputs@bin_dest. + +## Usage example + +```yaml +on: + - push + - pull_request + +jobs: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - uses: KSXGitHub/github-actions-setup-pnpm@master + with: + version: 4.11.1 + + - name: Install dependencies + run: pnpm install +``` + +## Notes + +This action does not setup Node.js for you, you use [actions/setup-node](https://github.com/actions/setup-node) yourself. + +## License + +[MIT](https://git.io/JfclH) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)