Skip to content

docs: redesign README with improved branding and feature descriptions #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

docs: redesign README with improved branding and feature descriptions #428

wants to merge 1 commit into from

Conversation

@jumski
Copy link
Contributor

@jumski jumski commented Nov 26, 2025

Redesigned README with Enhanced Visual and Content Presentation

This PR completely revamps the README to improve visual appeal and clarity of the project's value proposition. Key changes include:

  • Added a modern header with SVG logo, badges, and endorsement quote from Supabase CEO
  • Included an animated SVG diagram showing workflow execution with automatic retries
  • Restructured content to highlight key benefits and use cases more clearly
  • Added a quick start guide with code example showing the simplicity of workflow definitions
  • Improved package listing with version badges and links
  • Enhanced "Why pgflow?" section to better explain the problem being solved
  • Added comparison links to competing workflow solutions
  • Updated visual styling with better spacing and organization

The new README provides a more compelling introduction to pgflow, making it immediately clear how it solves workflow orchestration challenges in Supabase projects.

@changeset-bot
Copy link

changeset-bot bot commented Nov 26, 2025

⚠️ No Changeset found

Latest commit: 1ea0147

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 26, 2025 •
edited
Loading

Merge activity

  • Nov 26, 12:35 PM UTC: jumski added this pull request to the Graphite merge queue.
  • Nov 26, 12:36 PM UTC: CI is running for this pull request on a draft pull request (#429) due to your merge queue CI optimization settings.
  • Nov 26, 12:36 PM UTC: Merged by the Graphite merge queue via draft PR: #429.

@jumski Graphite App
Copy link
Contributor Author

jumski commented Nov 26, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge:queue - adds this PR to the back of the merge queue
  • hotfix:queue - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

graphite-app bot pushed a commit that referenced this pull request Nov 26, 2025
@jumski
docs: redesign README with improved branding and feature descriptions (…
246b98e 
…#428)

# Redesigned README with Enhanced Visual and Content Presentation

This PR completely revamps the README to improve visual appeal and clarity of the project's value proposition. Key changes include:

- Added a modern header with SVG logo, badges, and endorsement quote from Supabase CEO
- Included an animated SVG diagram showing workflow execution with automatic retries
- Restructured content to highlight key benefits and use cases more clearly
- Added a quick start guide with code example showing the simplicity of workflow definitions
- Improved package listing with version badges and links
- Enhanced "Why pgflow?" section to better explain the problem being solved
- Added comparison links to competing workflow solutions
- Updated visual styling with better spacing and organization

The new README provides a more compelling introduction to pgflow, making it immediately clear how it solves workflow orchestration challenges in Supabase projects.
@nx-cloud
Copy link

nx-cloud bot commented Nov 26, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 1ea0147

Command Status Duration Result
nx affected -t verify-exports --base=origin/mai... ✅ Succeeded <1s View ↗
nx affected -t build --configuration=production... ✅ Succeeded <1s View ↗
nx affected -t lint typecheck test --parallel -... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-26 12:36:54 UTC

@nx-cloud
Copy link

nx-cloud bot commented Nov 26, 2025

View your CI Pipeline Execution ↗ for commit 1ea0147

Command Status Duration Result
nx affected -t lint typecheck test --parallel -... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-26 12:36:20 UTC

@graphite-app graphite-app bot closed this Nov 26, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 26, 2025

🔍 Preview Deployment: Website

✅ Deployment successful!

🔗 Preview URL: https://pr-428.pgflow.pages.dev

📝 Details:

  • Branch: 11-25-make_readme_more_compelling
  • Commit: 79fb58e77c08b40a09fb7ef8fa9ff85496a9f8b7
  • View Logs

_Last updated: _

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jumski