update docs

Author: Patrick

.gitignore

@@ -6,5 +6,9 @@ composer.lock
 .php_cs.dist
 /coverage
 /scripts
-/docs
+/docs/*
+!/docs/automation.md
+!/docs/finders.md
+!/docs/rulesets/*.md
 .php_cs.ga.dist
+

README.md

@@ -183,6 +183,12 @@ The `custom` type will prompt you to enter the directory names you'd like `php-c
 
 ---
 
+## Automatic Formatting
+
+If you would like to automatically apply `php-cs-fixer` formatting using Github Actions, see the [automation with Github Actions](docs/automation.md) documentation.
+
+---
+
 ## [Finder Presets](docs/finders.md)
 
 #### `BasicProjectFinder`

docs/automation.md

@@ -0,0 +1,66 @@
+# Automatic Code Formatting
+
+If you'd like to automatically format your code whenever you push to your `main` branch, you can use the following Github Action workflow.  
+
+Save this file in your project directory as `.github/workflows/php-cs-fixer.yml`.
+
+---
+
+**This workflow makes several assumptions:** 
+
+- that your primary branch name is `main`, not something else such as `master`
+
+- that your `php-cs-fixer` configuration file is named `.php_cs.dist`
+
+If either of these differ from your setup, please adjust the workflow accordingly.
+
+---
+
+## `.github/workflows/php-cs-fixer.yml`
+
+```yaml
+name: Check & fix styling
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  php-cs-fixer:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      -   name: Setup PHP
+          uses: shivammathur/setup-php@v2
+          with:
+            php-version: 7.4
+            extensions: mbstring
+            coverage: none
+            tools: composer:v2
+
+      -   name: Cache dependencies
+          uses: actions/cache@v2
+          with:
+            path: ~/.composer/cache/files
+            key: dependencies-php-7.4-composer-${{ hashFiles('composer.json') }}
+
+      -   name: Install dependencies
+          run: composer install --prefer-dist --no-interaction --optimize-autoloader
+
+      -   name: Run PHP CS Fixer
+          run: vendor/bin/php-cs-fixer fix --config=.php_cs.dist --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling
+```

docs/finders.md

@@ -0,0 +1,77 @@
+## Finder Presets
+
+---
+
+#### [`BasicProjectFinder`](../src/Finders/BasicProjectFinder.php)
+
+**Name:** `project`
+
+**Features:**
+
+- ignores VCS files
+- ignores dot files
+- includes PHP files
+- excludes `vendor/` directory
+
+**Description:** basic project
+
+**Example:**
+
+```bash
+vendor/bin/pf-create-cs-config project
+```
+
+#### [`LaravelProjectFinder`](../src/Finders/LaravelProjectFinder.php)
+
+**Name:** `laravel`
+
+**Features:**
+
+- inherits [`BasicProjectFinder`](#basicprojectfinder) presets
+- excludes `*.blade.php` files
+- excludes all files in `bootstrap/`, `public/`, `resources/`, `storage/`
+- includes PHP files in `app/`, `config/`, `database/`, `routes/`, `tests/`
+
+**Description:**  standard laravel project
+
+**Example:**
+
+```bash
+vendor/bin/pf-create-cs-config laravel
+```
+
+#### [`LaravelPackageFinder`](../src/Finders/LaravelPackageFinder.php)
+
+**Name:** `laravel:package`
+
+**Features:**
+
+- inherits [`BasicProjectFinder`](#basicprojectfinder) presets
+- excludes `*.blade.php` files
+- excludes all files in `resources/`
+- includes PHP files in `src/`, `tests/`, `config/`
+
+**Description:** standard laravel package
+
+**Example:**
+
+```bash
+vendor/bin/pf-create-cs-config laravel:package
+```
+
+#### [`ComposerPackageFinder`](../src/Finders/ComposerPackageFinder.php)
+
+**Name:** `package`
+
+**Features:**
+
+- inherits [`BasicProjectFinder`](#basicprojectfinder) presets
+- includes PHP files in `src/`, `tests/`
+
+**Description:**  standard composer package
+
+**Example:**
+
+```bash
+vendor/bin/pf-create-cs-config package
+```