Skip to content

Commit aa92448

Browse files
committed
docs(readme): Improve the format
1 parent cabb067 commit aa92448

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ The preferred installation method is with the PHP Prefixer CLI PHAR. You can dow
4848

4949
You can install PHP-Prefixer CLI globally with Composer:
5050

51-
´´´sh
51+
```sh
5252
composer global require php-prefixer/php-prefixer-cli
53-
´´´
53+
```
5454

5555
## Usage
5656

5757
To use the command line, you must create an account on [PHP-Prefixer](https://php-prefixer.com/), and prepare your projects with the prefix definition in the `composer.json` schema.
5858

5959
Before using the command line, we recommend checking the documentation and guides here: <https://php-prefixer.com/docs/>
6060

61-
The command line requires four parameters, and it can receive an additional parameter:
61+
The command line requires four parameters, and it can receive an additional parameter for GitHub integration:
6262

6363
Parameter | Description
6464
---------|----------
@@ -69,23 +69,28 @@ project-id * | The identification of the configured project on [PHP-Prefixer](ht
6969
--github-access-token | An optional GitHub token to access ´composer.json´ dependencies that are managed in private repositories.
7070

7171
```bash
72-
# Sample command line
73-
php-prefixer-cli prefix \
74-
# Source Directory
75-
/sample/acme_project \
76-
# Target Directory
77-
/sample/prefixed_project \
78-
# Personal Access Token
79-
789|Qkfuf79mLwXBCoEhpxLl12DJbeqUJKs03ZFAq2Nd \
80-
# Project ID
81-
123456 \
82-
# GitHub Access Token
83-
--github-access-token=95c889f375458a9b33988af375458a3387ba6
72+
# Sample command line
73+
php-prefixer-cli prefix \
74+
\
75+
# Source Directory
76+
/sample/acme_project \
77+
\
78+
# Target Directory
79+
/sample/prefixed_project \
80+
\
81+
# Personal Access Token
82+
789|Qkfuf79mLwXBCoEhpxLl12DJbeqUJKs03ZFAq2Nd \
83+
\
84+
# Project ID
85+
123456 \
86+
\
87+
# GitHub Access Token
88+
--github-access-token=95c889f375458a9b33988af375458a3387ba6
8489
```
8590

8691
### Environment Variables
8792

88-
The command line supports the definition of the parameters as environment variables in a `.env` file in a project
93+
The command line supports the definition of the parameters as environment variables in a project `.env` file.
8994

9095
```yml
9196
# Sample .env
@@ -114,25 +119,29 @@ GITHUB_ACCESS_TOKEN="95c889f375458a9b33988af375458a3387ba6"
114119

115120
## Command Line Development
116121

117-
Clone the project
122+
Clone the project:
118123

119124
```bash
120125
git clone https://github.com/php-prefixer/php-prefixer-cli
121126
```
122127

123-
Go to the project directory
128+
Go to the project directory:
124129

125130
```bash
126131
cd php-prefixer-cli
127132
```
128133

129-
Install dependencies
134+
Install dependencies:
130135

131136
```bash
132137
composer update
133138
```
134139

135-
### Running Tests
140+
Build the PHAR:
141+
142+
```bash
143+
php-prefixer-cli app:build
144+
```
136145

137146
To run tests, run the following command:
138147

0 commit comments

Comments
 (0)