chore: README

Author: tianzhou

README.md

@@ -4,82 +4,50 @@ This repository demonstrates how to use [pgschema](https://www.pgschema.com/) wi
 
 ## Overview
 
-This repository contains two workflows:
-1. **Single File Workflow** - For projects with all schema definitions in one file
-2. **Multi File Workflow** - For projects with schema split across multiple SQL files
+### Plan Workflows (Pull Requests)
+
+- **Single File Plan** - Shows migration plan for single-file schemas
+- **Multi File Plan** - Shows migration plan for multi-file schemas
+
+Plan workflows automatically:
 
-Both workflows automatically:
 - Run `pgschema plan` when a PR modifies schema files
 - Post the migration plan as a comment on the PR
 - Update the comment if the PR is synchronized with new changes
 
+### Apply Workflows (Main Branch)
+
+- **Single File Apply** - Applies schema changes for single-file approach
+- **Multi File Apply** - Applies schema changes for multi-file approach
+
+Apply workflows automatically:
+
+- Run `pgschema apply` when changes are pushed to main branch
+- Use `--auto-approve` flag for automated deployment
+- Apply changes to a test PostgreSQL 17 container
+- Report success or failure with detailed logs
+
 ## Setup
 
-### 1. GitHub Secrets
+### GitHub Secrets
 
-No secrets required! Both workflows use a PostgreSQL 17 test container for demonstration purposes, making them fully self-contained.
+No secrets required! Both workflows start a PostgreSQL 17 test container for demonstration purposes, making them fully self-contained.
 
-### 2. Schema Organization
+### Schema Organization
 
 #### Single File Approach
-- Place your complete schema in `singlefile/schema.sql`
+
+- Place your complete schema in `singlefile/schema.sql`. This is generated by `pgschema dump --host localhost --user postgres --password testpwd1 --db employee --file schema.sql`.
 - All tables, indexes, functions, and triggers in one file
-- Uses PostgreSQL 17 test container (no external database needed)
-- Compares current branch schema against main branch schema
-- Workflow: `.github/workflows/pgschema-plan-single.yml`
+- Plan workflow: `.github/workflows/pgschema-singlefile-plan.yml`
+- Apply workflow: `.github/workflows/pgschema-singlefile-apply.yml`
 
 #### Multi File Approach
-- Place SQL files in the `multifile/` directory
+
+- Place SQL files in the `multifile/` directory. This is generated by `pgschema dump --host localhost --user postgres --password testpwd1 --db employee --multi-file --file main.sql`
 - Uses `main.sql` as the entry point with psql `\i` directives
-- Organize files by type in subdirectories (tables/, functions/, views/, etc.)
-- Each file contains a specific database object
-- Uses PostgreSQL 17 test container (no external database needed)
-- Compares current branch schema against main branch schema
-- Workflow: `.github/workflows/pgschema-plan-multi.yml`
-
-## Usage
-
-1. Choose your schema approach (single file or multi file)
-2. Create or update schema files in the appropriate directory
-3. Open a pull request
-4. The relevant workflow will automatically run and comment with the migration plan
-5. Review the plan to understand what changes will be applied
-6. The comment will be updated if you push more changes to the PR
-
-## Example Schemas
-
-### Single File Example
-See `singlefile/schema.sql` for a complete schema with:
-- Users and posts tables
-- Foreign key relationships
-- Indexes for performance
-- Triggers for auto-updating timestamps
-
-### Multi File Example
-See `multifile/` directory for a comprehensive schema organization:
-- `main.sql` - Entry file using psql `\i` directives to include other files
-- `domains/` - Custom domain types (email_address, positive_integer)
-- `types/` - Custom types (address, order_status, user_status)
-- `sequences/` - Sequence definitions (global_id_seq, order_number_seq)
-- `tables/` - Table definitions (users, orders)
-- `functions/` - Database functions (get_user_count, update_timestamp)
-- `procedures/` - Stored procedures (cleanup_orders, update_status)
-- `views/` - Database views (order_details, user_summary)
-
-This structure demonstrates how to organize complex schemas across multiple files and directories.
-
-## Security Notes
-
-- Both workflows use isolated PostgreSQL 17 test containers
-- No external database credentials required
-- Safe for demonstration and testing purposes
-- Containers are ephemeral and destroyed after each workflow run
-
-## Next Steps
-
-To apply migrations, you would typically:
-1. Review and approve the PR
-2. Run `pgschema apply` in your deployment pipeline
-3. Consider using `--auto-approve` flag for automated deployments
-
-For more information, visit the [pgschema documentation](https://www.pgschema.com/).
+- Organize files by type in subdirectories (tables/, functions/, views/, etc.). Each file contains a specific database object
+- Plan workflow: `.github/workflows/pgschema-multifile-plan.yml`
+- Apply workflow: `.github/workflows/pgschema-multifile-apply.yml`
+
+For more information, visit the [pgschema documentation](https://www.pgschema.com/).