Update readme

UseKeyp · Apr 19, 2023 · 61f195c · 61f195c
1 parent 7396d42
commit 61f195c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -59,6 +59,8 @@ jobs:
           packages-directory: packages
           # Which registry to use: github, npm
           registry: github 
+          # Name which will appear in the installation instruction
+          package-name: my-package
 ```
 
 ## Sponsors ❤️

diff --git a/action.yml b/action.yml
@@ -141,10 +141,10 @@ runs:
           Use the commands below to install the most recent version of the package(s) in this Pull Request. To install from a specific commit, use the version shown in the relevant Github Action run.
 
           ```bash
+          yarn add ${{ inputs.package-name }}@PR${{ steps.pr.outputs.pr_number }} 
+          
+          # If using the Github registry (For Yarn v3, use above command)
           yarn add ${{ inputs.package-name }}@PR${{ steps.pr.outputs.pr_number }} --registry https://npm.pkg.github.com
-
-          # For Yarn v3
-          yarn add ${{ inputs.package-name }}@PR${{ steps.pr.outputs.pr_number }}
           ```
 
           <details><summary>:octocat: 🔒 Click here for instructions on installing this package from the ${{ inputs.registry }} registry.</summary>