Skip to content

Improve the README's initial sections#205

Merged
pinodeca merged 1 commit into
mainfrom
pinodeca/improve-readme
Jun 4, 2026
Merged

Improve the README's initial sections#205
pinodeca merged 1 commit into
mainfrom
pinodeca/improve-readme

Conversation

@pinodeca

@pinodeca pinodeca commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • refresh the opening of the README to better explain what pg_durable is
  • clarify who the project is for near the top of the document
  • keep the intro aligned with the current positioning of durable execution inside PostgreSQL

Changes

  • update top-level hero/intro content in README.md
  • adjust early section flow so readers can quickly decide if pg_durable fits their use case

Validation

  • documentation-only change
  • reviewed rendered markdown for readability and flow

Make the top of the README address what it is and who it's for.

@AbeOmor AbeOmor left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with small nit

Comment thread README.md
~> 'UPDATE documents SET processed = true WHERE id = ANY($batch)'
);
```
Durable execution is now a standard industry pattern, and pg_durable brings it inside Postgres with no extra service infrastructure required. Part of our mission to bring compute close to data.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should it be...
bring "compute closer to data"?

@tjgreen42 tjgreen42 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good progress

Comment thread README.md
</div>

### Who it's for
### Workloads this is useful for

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These subsections of the README get to be visually a sea of headings and bullets, very text-heavy. Might be nice to sprinkle some color (e.g. via code examples) and also reduce the # of bullets in a followup.

@pinodeca pinodeca merged commit 3b864ca into main Jun 4, 2026
5 checks passed
@pinodeca pinodeca deleted the pinodeca/improve-readme branch June 4, 2026 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants