Skip to content

Commit 0b4205c

Browse files
authored
Improves the README with more badges, Pypi statistics, contributor recognition, and star history
1 parent 9d27a52 commit 0b4205c

File tree

4 files changed

+28
-5
lines changed

4 files changed

+28
-5
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,22 @@
22

33
---
44

5-
[![PyPI version](https://img.shields.io/pypi/v/selectolax.svg)](https://pypi.python.org/pypi/selectolax)
5+
A fast HTML5 parser with CSS selectors, written in Cython,
6+
using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://github.com/lexbor/lexbor) engines.
67

7-
A fast HTML5 parser with CSS selectors using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://github.com/lexbor/lexbor) engines.
8+
---
9+
10+
[![PyPI - Version](https://img.shields.io/pypi/v/selectolax?logo=pypi&label=Pypi&logoColor=fff)](https://pypi.org/project/selectolax)
11+
[![PyPI Total Downloads](https://static.pepy.tech/badge/selectolax)](https://pepy.tech/projects/selectolax)
12+
[![PyPI Monthly Downloads](https://static.pepy.tech/badge/selectolax/month)](https://pepy.tech/projects/selectolax)
13+
[![PyPI Weekly Downloads](https://static.pepy.tech/badge/selectolax/week)](https://pepy.tech/projects/selectolax)
14+
15+
[![Python Versions](https://img.shields.io/pypi/pyversions/selectolax?logo=python&logoColor=fff&label=Python)](https://pypi.org/project/selectolax)
16+
17+
[![CI](https://img.shields.io/github/actions/workflow/status/rushter/selectolax/pythonpackage.yml?branch=master&logo=githubactions&label=CI)](https://github.com/rushter/selectolax/actions/workflows/pythonpackage.yml?query=branch%3Amaster+event%3Apush)
18+
[![GitHub License](https://img.shields.io/github/license/rushter/selectolax?logo=github&label=License)](https://github.com/rushter/selectolax/blob/master/LICENSE)
19+
20+
---
821

922
## Installation
1023

@@ -152,3 +165,12 @@ Out[4]: '2021-08-15'
152165
* Modest engine — [LGPL2.1](https://github.com/lexborisov/Modest/blob/master/LICENSE)
153166
* lexbor engine — [Apache-2.0 license](https://github.com/lexbor/lexbor?tab=Apache-2.0-1-ov-file#readme)
154167
* selectolax - [MIT](https://github.com/rushter/selectolax/blob/master/LICENSE)
168+
169+
170+
## Contributors
171+
172+
Thanks to all the contributors of selectolax!
173+
174+
<a href="https://github.com/rushter/selectolax/graphs/contributors">
175+
<img src="https://contrib.rocks/image?repo=rushter/selectolax" />
176+
</a>

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
selectolax
22
==========
33

4-
Selectolax is a fast HTML5 parser with CSS selectors.
4+
Selectolax is a fast HTML5 parser with CSS selectors, written in Cython,
5+
using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://github.com/lexbor/lexbor) engines.
56

67
It supports two backends:
78

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ requires = [
88
[project]
99
name = 'selectolax'
1010
version = '0.4.3'
11-
description = 'Fast HTML5 parser with CSS selectors.'
11+
description = 'A fast HTML5 parser with CSS selectors, written in Cython, using Modest and Lexbor engines.'
1212
readme = 'README.md'
1313
requires-python = '>=3.9,<3.15'
1414
license = 'MIT'

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ def make_extensions():
192192
setup(
193193
name="selectolax",
194194
version="0.4.3",
195-
description="Fast HTML5 parser with CSS selectors.",
195+
description="A fast HTML5 parser with CSS selectors, written in Cython, using Modest and Lexbor engines.",
196196
long_description=readme,
197197
author="Artem Golubin",
198198
author_email="me@rushter.com",

0 commit comments

Comments
 (0)