Skip to content

Improves the README with more badges, Pypi statistics, contributor recognition, and star history!#189

Merged
rushter merged 5 commits intorushter:masterfrom
pygarap:improve-readme
Nov 22, 2025
Merged

Improves the README with more badges, Pypi statistics, contributor recognition, and star history!#189
rushter merged 5 commits intorushter:masterfrom
pygarap:improve-readme

Conversation

@pygarap
Copy link
Contributor

@pygarap pygarap commented Nov 21, 2025

This pull request updates the project description and documentation to better highlight selectolax's speed, technology stack, and community activity. It also improves the README with more badges, usage examples, contributor recognition, and links to statistics and star history.

Documentation and Branding Updates:

  • Updated the project description in README.md, pyproject.toml, setup.py, and docs/index.rst to emphasize that selectolax is "an extremely fast HTML5 parser with CSS selectors, written in Cython, using Modest and Lexbor engines" [1] [2] [3] [4].
  • Enhanced the top of the README.md with additional badges for PyPI version, downloads, supported platforms, Python versions, CI status, license, release date, commit activity, and contributors.

Improved Examples and Formatting:

  • Reformatted Python code examples in README.md for better readability and consistency, including improved spacing and output formatting [1] [2] [3].

Community and Statistics Sections:

  • Added sections in README.md to recognize contributors, display a contributors image, and link to PyPI/libraries.io/deps.dev statistics.
  • Included a "Star History" section with a dynamic chart showing the project's star growth over time.

Other Minor Improvements:

  • Improved line wrapping and formatting in the benchmark section of the README.md for clarity.… for enhanced clarity and consistency

@pygarap
Copy link
Contributor Author

pygarap commented Nov 21, 2025

@rushter Thank you for the review and the helpful comments.

I have addressed all of your concerns and pushed the updated changes.
Please let me know if you would like me to make any further adjustments.

@pygarap pygarap requested a review from rushter November 21, 2025 19:42
@rushter rushter merged commit 0b4205c into rushter:master Nov 22, 2025
7 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.

2 participants