Merge pull request #1 from xuanyanwow/add-readme

friendsofhyperf · Dec 18, 2023 · cddd281 · cddd281
2 parents 896ec18 + 96bfae0
commit cddd281
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /vendor
 /.vscode
 .bashrc
-composer.lock
+composer.lock
+.idea
diff --git a/README.md b/README.md
@@ -33,6 +33,22 @@ return static function (RectorConfig $rectorConfig): void {
 
 <br>
 
+## Run Rector
+
+the source directory (e.g. `src`) is optional.
+
+### 1. Dry Run - Preview Changes
+
+```bash
+vendor/bin/rector process src --dry-run
+```
+
+### 2. Run Rector and Let It Change Your Code
+
+```bash
+vendor/bin/rector process src
+```
+
 ## Learn Rector Faster
 
 Rector is a tool that [we develop](https://getrector.org/) and share for free, so anyone can save hundreds of hours on refactoring. But not everyone has time to understand Rector and AST complexity. You have 2 ways to speed this process up: