Skip to content

Commit 2b8e6dc

Browse files
committed
docs(readme): Publish more readme tweaks
1 parent aa92448 commit 2b8e6dc

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
66

7-
A command-line for the [PHP-Prefixer](https://php-prefixer.com) service. The command calls the **PHP-Prefixer** service using the [REST API](https://php-prefixer.com/docs/rest-api-reference/) to submit a project source code, apply the prefixes, wait and download the results.
7+
A command-line for the [PHP-Prefixer](https://php-prefixer.com) service.
8+
9+
The [PHP-Prefixer](https://php-prefixer.com) service has a command line to use the service locally and process the project source code from your workstation.
10+
11+
The command calls the **PHP-Prefixer** service using the [REST API](https://php-prefixer.com/docs/rest-api-reference/) to submit a project source code, apply the prefixes, wait and download the results.
812

913
**PHP-Prefixer** is a cloud service to apply PHP prefixes to namespaces, functions, helpers, traits, interfaces, etc. Start with a Composer project and a set of dependencies, and prefix all library files at once to generate a consistent prefixed codebase.
1014

@@ -42,19 +46,19 @@ class Carbon extends DateTime
4246

4347
### PHAR
4448

45-
The preferred installation method is with the PHP Prefixer CLI PHAR. You can download the latest PHAR from the most recent [Github Releases](https://github.com/PHP-Prefixer/php-prefixer-cli/releases).
49+
The preferred installation method is with the **PHP Prefixer CLI PHAR**. You can download the latest PHAR from the most recent [Github Releases](https://github.com/PHP-Prefixer/php-prefixer-cli/releases). After downloading it, copy the file into a directory on your local path.
4650

4751
### Composer
4852

49-
You can install PHP-Prefixer CLI globally with Composer:
53+
Alternatively, you can install **PHP-Prefixer CLI** globally with Composer:
5054

5155
```sh
5256
composer global require php-prefixer/php-prefixer-cli
5357
```
5458

5559
## Usage
5660

57-
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.
61+
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.
5862

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

@@ -79,13 +83,13 @@ php-prefixer-cli prefix \
7983
/sample/prefixed_project \
8084
\
8185
# Personal Access Token
82-
789|Qkfuf79mLwXBCoEhpxLl12DJbeqUJKs03ZFAq2Nd \
86+
789|1234567890123456789012345678901234567890 \
8387
\
8488
# Project ID
8589
123456 \
8690
\
8791
# GitHub Access Token
88-
--github-access-token=95c889f375458a9b33988af375458a3387ba6
92+
--github-access-token=1234567890123456789012345678901234567890
8993
```
9094

9195
### Environment Variables
@@ -102,13 +106,13 @@ SOURCE_DIRECTORY="/sample/acme_project"
102106
TARGET_DIRECTORY="/sample/prefixed_project"
103107

104108
# Personal Access Token
105-
PERSONAL_ACCESS_TOKEN="789|Qkfuf79mLwXBCoEhpxLl12DJbeqUJKs03ZFAq2Nd"
109+
PERSONAL_ACCESS_TOKEN="789|1234567890123456789012345678901234567890"
106110

107111
# Project ID
108112
PROJECT_ID="123456"
109113

110114
# GitHub Access Token
111-
GITHUB_ACCESS_TOKEN="95c889f375458a9b33988af375458a3387ba6"
115+
GITHUB_ACCESS_TOKEN="1234567890123456789012345678901234567890"
112116
```
113117

114118
## Documentation

0 commit comments

Comments
 (0)