Skip to content

Commit e7f9a1d

Browse files
committed
docs: Update wording
1 parent 0d61dd4 commit e7f9a1d

File tree

4 files changed

+16
-38
lines changed

4 files changed

+16
-38
lines changed

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ into:
3434
</html>
3535
```
3636

37-
- Uses reliable components from Mozilla's Servo
37+
- Uses reliable components from Mozilla's Servo project
3838
- Inlines CSS from `style` and `link` tags
3939
- Removes `style` and `link` tags
4040
- Resolves external stylesheets (including local files)
@@ -135,14 +135,6 @@ fn main() -> Result<(), css_inline::InlineError> {
135135
}
136136
```
137137

138-
## Standards support & restrictions
139-
140-
`css-inline` is built on top of [html5ever](https://crates.io/crates/html5ever) and [cssparser](https://crates.io/crates/cssparser) and relies on their behavior for HTML & CSS parsing.
141-
142-
- Only HTML 5 is supported, not XHTML.
143-
- Only CSS 3 is supported.
144-
- Only UTF-8 encoding for string representation. Other document encodings are not yet supported.
145-
146138
## Bindings
147139

148140
`css-inline` is primarily a Rust library, but we also provide bindings for several other languages:
@@ -176,7 +168,7 @@ For full details of the options available, you can use the `--help` flag:
176168
css-inline --help
177169
```
178170

179-
## Extra materials
171+
## Further reading
180172

181173
If you're interested in learning how this library was created and how it works internally, check out these articles:
182174

bindings/python/README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
[<img alt="codecov.io" src="https://img.shields.io/codecov/c/gh/Stranger6667/css-inline?logo=codecov&style=flat-square&token=tOzvV4kDY0" height="20">](https://app.codecov.io/github/Stranger6667/css-inline)
88
[<img alt="gitter" src="https://img.shields.io/gitter/room/Stranger6667/css-inline?style=flat-square" height="20">](https://gitter.im/Stranger6667/css-inline)
99

10-
`css-inline` inlines CSS into HTML documents, using components from Mozilla's Servo project.
10+
`css_inline` is a high-performance library for inlining CSS into HTML 'style' attributes.
1111

12-
This process is essential for sending HTML emails as you need to use "style" attributes instead of "style" tags.
12+
This library is designed for scenarios such as preparing HTML emails or embedding HTML into third-party web pages.
1313

1414
For instance, the library transforms HTML like this:
1515

@@ -35,7 +35,7 @@ into:
3535
</html>
3636
```
3737

38-
- Uses reliable components from Mozilla's Servo
38+
- Uses reliable components from Mozilla's Servo project
3939
- 10-300x faster than alternatives
4040
- Inlines CSS from `style` and `link` tags
4141
- Removes `style` and `link` tags
@@ -52,8 +52,8 @@ Install with `pip`:
5252
pip install css_inline
5353
```
5454

55-
Pre-compiled wheels for most popular platforms are provided. If your platform is not supported, you will need
56-
a Rust compiler to build this package from source. The minimum supported Rust version is 1.60.
55+
Pre-compiled wheels are available for most popular platforms.
56+
If not available for your platform, a Rust compiler will be needed to build this package from source. Rust version 1.60 or higher is required.
5757

5858
## Usage
5959

@@ -148,13 +148,7 @@ inliner = css_inline.CSSInliner(base_url="file://styles/email/")
148148
inliner.inline("...")
149149
```
150150

151-
## Standards support & restrictions
152-
153-
`css-inline` is built on top of [html5ever](https://crates.io/crates/html5ever) and [cssparser](https://crates.io/crates/cssparser) and relies on their behavior for HTML & CSS parsing.
154-
155-
- Only HTML 5 is supported, not XHTML.
156-
- Only CSS 3 is supported.
157-
- Only UTF-8 encoding for string representation. Other document encodings are not yet supported.
151+
## XHTML compatibility
158152

159153
If you'd like to work around some XHTML compatibility issues like closing empty tags (`<hr>` vs. `<hr/>`), you can use the following snippet that involves `lxml`:
160154

@@ -200,7 +194,7 @@ Besides performance, `css-inline` differs from other Python libraries for CSS in
200194

201195
`css_inline` supports CPython 3.7, 3.8, 3.9, 3.10, 3.11 and PyPy 3.7, 3.8, 3.9.
202196

203-
## Extra materials
197+
## Further reading
204198

205199
If you want to know how this library was created & how it works internally, you could take a look at these articles:
206200

bindings/ruby/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[<img alt="codecov.io" src="https://img.shields.io/codecov/c/gh/Stranger6667/css-inline?logo=codecov&style=flat-square&token=tOzvV4kDY0" height="20">](https://app.codecov.io/github/Stranger6667/css-inline)
66
[<img alt="gitter" src="https://img.shields.io/gitter/room/Stranger6667/css-inline?style=flat-square" height="20">](https://gitter.im/Stranger6667/css-inline)
77

8-
`css_inline` inlines CSS into HTML documents, using components from Mozilla's Servo project.
8+
`css_inline` is a high-performance library for inlining CSS into HTML 'style' attributes.
99

10-
This process is essential for sending HTML emails as you need to use "style" attributes instead of "style" tags.
10+
This library is designed for scenarios such as preparing HTML emails or embedding HTML into third-party web pages.
1111

1212
For instance, the library transforms HTML like this:
1313

@@ -33,7 +33,7 @@ into:
3333
</html>
3434
```
3535

36-
- Uses reliable components from Mozilla's Servo
36+
- Uses reliable components from Mozilla's Servo project
3737
- Inlines CSS from `style` and `link` tags
3838
- Removes `style` and `link` tags
3939
- Resolves external stylesheets (including local files)
@@ -149,7 +149,7 @@ The results displayed above were measured using stable `rustc 1.70` on Ruby `3.2
149149

150150
`css_inline` supports Ruby 2.7 and 3.2.
151151

152-
## Extra materials
152+
## Further reading
153153

154154
If you want to know how this library was created & how it works internally, you could take a look at these articles:
155155

bindings/wasm/README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[<img alt="codecov.io" src="https://img.shields.io/codecov/c/gh/Stranger6667/css-inline?logo=codecov&style=flat-square&token=tOzvV4kDY0" height="20">](https://app.codecov.io/github/Stranger6667/css-inline)
66
[<img alt="gitter" src="https://img.shields.io/gitter/room/Stranger6667/css-inline?style=flat-square" height="20">](https://gitter.im/Stranger6667/css-inline)
77

8-
`css-inline` inlines CSS into HTML documents, using components from Mozilla's Servo project.
8+
`css-inline` is a high-performance library for inlining CSS into HTML 'style' attributes.
99

10-
This process is essential for sending HTML emails as you need to use "style" attributes instead of "style" tags.
10+
This library is designed for scenarios such as preparing HTML emails or embedding HTML into third-party web pages.
1111

1212
For instance, the library transforms HTML like this:
1313

@@ -33,7 +33,7 @@ into:
3333
</html>
3434
```
3535

36-
- Uses reliable components from Mozilla's Servo
36+
- Uses reliable components from Mozilla's Servo project
3737
- Inlines CSS from `style` and `link` tags
3838
- Removes `style` and `link` tags
3939
- Resolves external stylesheets (including local files)
@@ -102,14 +102,6 @@ The `data-css-inline="ignore"` attribute also allows you to skip `link` and `sty
102102
</body>
103103
```
104104

105-
## Standards support & restrictions
106-
107-
`css-inline` is built on top of [html5ever](https://crates.io/crates/html5ever) and [cssparser](https://crates.io/crates/cssparser) and relies on their behavior for HTML & CSS parsing.
108-
109-
- Only HTML 5 is supported, not XHTML.
110-
- Only CSS 3 is supported.
111-
- Only UTF-8 encoding for string representation. Other document encodings are not yet supported.
112-
113105
## License
114106

115107
This project is licensed under the terms of the [MIT license](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)