Skip to content

Commit 39bac99

Browse files
committed
docs(readme): Correct and extend info
1 parent c39e940 commit 39bac99

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ An example repository has been created at https://github.com/PHP-Prefixer/hello-
4646

4747
## Usage
4848

49-
To use the Action, you must create an account on [PHP-Prefixer](https://php-prefixer.com/) and prepare your projects with the prefix defined in the `composer.json` schema. Before using the Action and the command-line, we recommend checking the documentation and guides here: <https://php-prefixer.com/docs/>. You can also prefix your firsts projects on the service web interface.
49+
To use the Action, you must create an account on [PHP-Prefixer](https://php-prefixer.com/) and prepare your projects with the prefix defined in the `composer.json` schema. Before using the Action and the command-line, we recommend checking the documentation and guides here: <https://php-prefixer.com/docs/>. You can also prefix your firsts projects on the service web interface, and in a second step, integrate Action in your repositories.
5050

5151
Create your Github Workflow configuration in `.github/workflows/prefixer.yml` or similar.
5252

@@ -64,7 +64,7 @@ jobs:
6464
uses: actions/checkout@v2
6565

6666
- name: Run PHP-Prefixer
67-
uses: PHP-Prefixer/php-prefixer-build-action@v0.0.1
67+
uses: PHP-Prefixer/php-prefixer-build-action@v0.0.2
6868
env:
6969
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7070
with:
@@ -79,11 +79,11 @@ The Action requires two parameters to function, and it can receive additional pa
7979

8080
Parameter | Description | Required | Example
8181
---------|----------| ---------|----------
82-
PERSONAL_ACCESS_TOKEN | The PHP-Prefixer PAT/Personal Access Token. The token must be configured in the PHP-Prefixer account. | Yes | `789|1234567890123456789012345678901234567890`
82+
PERSONAL_ACCESS_TOKEN | The PHP-Prefixer PAT/Personal Access Token. The token must be configured in the PHP-Prefixer account. | Yes | `789\|123456789...`
8383
PROJECT_ID | The project ID to process the source code. The project must be configured in your account in the PHP-Prefixer account. | Yes | `5432`
8484
SOURCE_DIR_PATH | The relative path to the source project directory. It must contain a .git repository and composer.json file. If not, set the base repository directory will be used as the value. Example: `foo/bar`. | No | `./`
85-
TARGET_BRANCH | The branch in the repository where PHP-Prefixer will store the prefixed files after processing. | No | `prefixed`
86-
GH_PERSONAL_ACCESS_TOKEN | The GitHub PAT/Personal Access Token to access private repositories. It is only required if the project, the library or the dependencies are private. | No |
85+
TARGET_BRANCH | The branch in the repository where PHP-Prefixer will store the prefixed files after processing. Default value: `prefixed`. | No |
86+
GH_PERSONAL_ACCESS_TOKEN | The GitHub PAT/Personal Access Token to access private repositories. It is only required if the project, the library or the dependencies are private. | No | `ghp_F4fZ9Cq7QF...`
8787

8888
## Prefixing Private Repositories
8989

@@ -102,7 +102,7 @@ jobs:
102102
...
103103

104104
- name: Run PHP-Prefixer
105-
uses: PHP-Prefixer/php-prefixer-build-action@v0.0.1
105+
uses: PHP-Prefixer/php-prefixer-build-action@v0.0.2
106106
env:
107107
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
108108
with:

0 commit comments

Comments
 (0)