Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasVotruba committed Jan 22, 2025
1 parent 06fa0f0 commit 983fa8a
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,36 @@ composer require symplify/config-transformer --dev

## Usage

By default, the command uses `/config` directory to transform all files in it:
By default, the command uses `/config` directory to transform all files in it. At first, try to run it with `--dry-run`, just to see what files *would be* transformed:

```bash
vendor/bin/config-transformer
vendor/bin/config-transformer --dry-run
```

Do you want to convert 1 files or directory at a time? Specify the paths as arguments:
<br>

Do you want to convert single file or directory at a time? Specify the paths as arguments:

```bash
vendor/bin/config-transformer convert config/parameters.yml
vendor/bin/config-transformer config/parameters.yml --dry-run
```

<br>

Are you ready to go? Remove `--dry-run`:

```bash
vendor/bin/config-transformer
```

The input files are deleted automatically.

<br>

### Skip Routes at First

It's typical to upgrade first services and then routes as follow up PR. To do that, use `--skip-routes` option:

```bash
vendor/bin/config-transformer --skip-routes
```

0 comments on commit 983fa8a

Please sign in to comment.