Skip to content

Commit c0d47e9

Browse files
committed
Update READMEs
1 parent 098d484 commit c0d47e9

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

.github/workflows/CI.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ on:
1717
- LICENSE
1818
- LICENSE-MIT
1919
- LICENSE-BSD
20-
- examples
20+
- "examples/*"
2121
pull_request:
2222
workflow_dispatch:
2323

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717

1818
<div align="center">
1919

20-
[💼 Purpose](#purpose) | [⚡ Performance](#performance) | [⚙️ Usage](#usage) | [⚖️ License](#license)
20+
[💼 Purpose](#purpose) | [⚡ Performance](#performance) | [🛠️ Installation](#installation) | [⚙️ Usage](#usage) |
21+
[⚖️ License](#license)
2122

2223
</div>
2324

@@ -110,6 +111,20 @@ print("python-lolhtml Speedup:", beautiful_soup_time / python_lolhtml_time)
110111

111112
</details>
112113

114+
# Installation
115+
116+
python-lolhtml is available for installation from PyPI:
117+
118+
```shell
119+
python -m pip install python-lolhtml
120+
```
121+
122+
For the latest development builds, you may alternatively build the package yourself from GitHub:
123+
124+
```shell
125+
python3 -m pip install git+https://github.com/Jayson-Fong/python-lolhtml.git
126+
```
127+
113128
# Usage
114129

115130
For each rewriting or parsing task, a `lolhtml.HTMLRewriter` instance is required. It includes a buffer that can be

examples/content-insertion/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ Content Insertion
33

44
This example leverages python-lolhtml to insert a navigation link into a webpage.
55

6-
It specifically inserts a new `Sales` navigation entry after the 2nd navigation entry using the following CSS selector:
6+
It specifically inserts a new `Sales` navigation entry after the second navigation entry using the following CSS
7+
selector:
78

89
```css
910
nav > ul > li:nth-of-type(2)

0 commit comments

Comments
 (0)