Skip to content

Commit 945539c

Browse files
committed
docs(readme): Improve .env sample
1 parent 8e85b8d commit 945539c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,23 @@ php-prefixer-cli prefix \
9292
The command line supports the definition of the parameters as environment variables in a project `.env` file.
9393

9494
```yml
95-
# Sample .env
95+
# PHP Prefixer CLI - Sample .env
9696

97-
# Source Directory
97+
# Note: the .env file must be located in the php-prefixer-cli.phar directory
98+
99+
# Source Directory: The project source directory
98100
SOURCE_DIRECTORY="/sample/acme_project"
99101

100-
# Target Directory
102+
# Target Directory: The target directory where the results are stored
101103
TARGET_DIRECTORY="/output/prefixed_project"
102104

103-
# Personal Access Token
105+
# Personal Access Token: The personal access token, generated on PHP-Prefixer/ Settings.
104106
PERSONAL_ACCESS_TOKEN="789|1234567890123456789012345678901234567890"
105107

106-
# Project ID
108+
# Project ID: The identification of the configured project on PHP-Prefixer/ Projects.
107109
PROJECT_ID="123456"
108110

109-
# GitHub Access Token
111+
# GitHub Access Token: An optional GitHub token to access composer.json dependencies that are managed in private repositories.
110112
GITHUB_ACCESS_TOKEN="1234567890123456789012345678901234567890"
111113
```
112114

0 commit comments

Comments
 (0)