Skip to content

Simplify README.md #825

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.

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

Merged
merged 2 commits into from
May 12, 2025
Merged

Simplify README.md #825

merged 2 commits into from
May 12, 2025

Conversation

kvch
Copy link
Contributor

@kvch kvch commented May 12, 2025

This PR simplifies the readme of pgroll.

I moved the section "How pgroll works" lower, before the documentation link. Now installation and basic tutorial are easier to find. It does not get lost in the 1000 lines long readme.

I also added two new badges: documentation and download count.

@github-actions github-actions bot temporarily deployed to Docs Preview May 12, 2025 10:20 Inactive
@kvch kvch force-pushed the simplify-readme branch from 841607e to 970a2f4 Compare May 12, 2025 10:23
@github-actions github-actions bot temporarily deployed to Docs Preview May 12, 2025 10:23 Inactive
@exekias
Copy link
Member

exekias commented May 12, 2025

I believe this section is valuable for understanding what the project is about. I would be more ok with moving it down if we believe it's a problem. Personally I'm fine with it as it is

Copy link

@gulcin gulcin left a comment

Choose a reason for hiding this comment

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

I wonder if we can keep it but maybe place it somewhere after the necessary information you'd like to emphasize? I think @exekias suggested smth similar.

@github-actions github-actions bot temporarily deployed to Docs Preview May 12, 2025 12:49 Inactive
@kvch kvch requested a review from gulcin May 12, 2025 12:49
@kvch
Copy link
Contributor Author

kvch commented May 12, 2025

I added the section about pgroll internals back to the readme.

Copy link

@gulcin gulcin left a comment

Choose a reason for hiding this comment

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

LGTM!

@kvch kvch merged commit 034cb1e into xataio:main May 12, 2025
30 checks passed
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