docs: Misc updates

Author: Stranger6667

README.md

@@ -37,6 +37,13 @@ into:
 </html>
 ```
 
+- Uses reliable components from Mozilla's Servo
+- Inlines CSS from `style` and `link` tags
+- Removes `style` and `link` tags
+- Resolves external stylesheets (including local files)
+- Works on Linux, Windows, and macOS
+- Supports HTML5 & CSS3
+
 ## Installation
 
 To include it in your project, add the following line to the dependencies section in your project's `Cargo.toml` file:
@@ -68,7 +75,7 @@ fn main() -> Result<(), css_inline::InlineError> {
 }
 ```
 
-### Features & Configuration
+### Configuration
 
 `css-inline` can be configured by using `CSSInliner::options()` that implements the Builder pattern:
 
@@ -148,44 +155,27 @@ We provide bindings for Python and WebAssembly. Check the `bindings` directory f
 
 ## Command Line Interface
 
-`css-inline` provides a command-line interface:
-
-```text
-css-inline --help
-
-css-inline inlines CSS into HTML documents.
-
-USAGE:
-   css-inline [OPTIONS] [PATH ...]
-   command | css-inline [OPTIONS]
+### Installation
 
-ARGS:
-    <PATH>...
-        An HTML document to process. In each specified document
-        "css-inline" will look for all relevant "style" and "link"
-        tags, will load CSS from them and then inline it to the
-        HTML tags, according to the corresponding CSS selectors.
-        When multiple documents are specified, they will be
-        processed in parallel, and each inlined file will be saved
-        with an "inlined." prefix. For example, for "example.html",
-        there will be "inlined.example.html".
+Install with `cargo`:
 
-OPTIONS:
+```
+cargo install css-inline
+```
 
-    --keep-style-tags
-        Keep "style" tags after inlining.
+### Usage
 
-    --base-url
-        The base URL used to resolve relative URLs.
+The following command inlines CSS in multiple documents in parallel. Resulting files will be saved
+as `inlined.email1.html` and `inlined.email2.html`:
 
-    --load-remote-stylesheets
-        Specifies if remote stylesheets should be loaded or not.
+```
+css-inline email1.html email2.html
+```
 
-    --extra-css
-        Additional CSS to inline.
+For full details of the options available, you can use the `--help` flag:
 
-    --output-filename-prefix
-        Custom prefix for output files. Defaults to `inlined.`.
+```
+css-inline --help
 ```
 
 ## Extra materials

bindings/python/README.md

@@ -38,15 +38,18 @@ into:
 </html>
 ```
 
-- 10-350x faster than existing CSS inliners;
-- Removing `style` tags after inlining;
-- Resolving external stylesheets (including local files);
-- Out-of-document CSS to inline;
-- Inlining multiple documents in parallel (via Rust-level threads)
+- Uses reliable components from Mozilla's Servo
+- 10-300x faster than alternatives
+- Inlines CSS from `style` and `link` tags
+- Removes `style` and `link` tags
+- Resolves external stylesheets (including local files)
+- Can process multiple documents in parallel
+- Works on Linux, Windows, and macOS
+- Supports HTML5 & CSS3
 
 ## Installation
 
-To install `css_inline` via `pip` run the following command:
+Install with `pip`:
 
 ```
 pip install css_inline
@@ -57,8 +60,6 @@ a Rust compiler to build this package from source. The minimum supported Rust ve
 
 ## Usage
 
-To inline CSS in an HTML document:
-
 ```python
 import css_inline
 
@@ -96,7 +97,9 @@ css_inline.inline_many(["<...>", "<...>"])
 
 `inline_many` will spawn threads on the Rust level; thus, you can expect it's running faster than `css_inline.inline` via Python's `multiprocessing` or `threading` modules.
 
-For customization options use the `CSSInliner` class:
+### Configuration
+
+For configuration options use the `CSSInliner` class:
 
 ```python
 import css_inline

bindings/python/pyproject.toml

@@ -13,9 +13,10 @@ known_third_party = []
 
 [project]
 name = "css-inline"
-description = "Fast CSS inlining written in Rust"
+description = "High-performance library for inlining CSS into HTML 'style' attributes"
+keywords = ["css", "html", "email", "stylesheet", "inlining"]
 authors = [
-    {name = "Dmitry Dygalo", email = "[email protected]"}
+    { name = "Dmitry Dygalo", email = "[email protected]" }
 ]
 license = { text = "MIT" }
 classifiers=[

bindings/wasm/Cargo.toml

@@ -4,9 +4,9 @@ version = "0.9.0"
 authors = ["Dmitry Dygalo <[email protected]>"]
 edition = "2021"
 readme = "README.md"
-description = "A WASM package for inlining CSS into HTML documents"
+description = "High-performance library for inlining CSS into HTML 'style' attributes"
 repository = "https://github.com/Stranger6667/css-inline"
-keywords = ["html", "css", "css-inline"]
+keywords = ["css", "html", "email", "stylesheet", "inlining"]
 categories = ["web-programming"]
 license = "MIT"
 rust-version = "1.60"

bindings/wasm/README.md

@@ -36,8 +36,20 @@ into:
 </html>
 ```
 
-- Removing ``style`` tags after inlining;
-- Out-of-document CSS to inline;
+- Uses reliable components from Mozilla's Servo
+- Inlines CSS from `style` and `link` tags
+- Removes `style` and `link` tags
+- Resolves external stylesheets (including local files)
+- Works on Linux, Windows, and macOS
+- Supports HTML5 & CSS3
+
+## Install
+
+Install with `npm`:
+
+```
+npm install --save css-inline
+```
 
 ## Usage
 
@@ -56,21 +68,12 @@ var inlined = inline(
     </body>
   </html>
   `,
-  { keep_style_tags: true }
 )
-// Inlined HTML looks like this:
-// <html>
-//   <head>
-//     <title>Test</title>
-//     <style>h1 { color:red; }</style>
-//   </head>
-//   <body>
-//     <h1 style="color:red;">Test</h1>
-//   </body>
-// </html>
 // Do something with the inlined HTML, e.g. send an email
 ```
 
+### Configuration
+
 - `keep_style_tags`. Specifies whether to keep "style" tags after inlining. Default: `false`
 - `keep_link_tags`. Specifies whether to keep "link" tags after inlining. Default: `false`
 - `base_url`. The base URL used to resolve relative URLs. If you'd like to load stylesheets from your filesystem, use the `file://` scheme. Default: `null`

css-inline/Cargo.toml

@@ -5,9 +5,9 @@ authors = ["Dmitry Dygalo <[email protected]>"]
 edition = "2021"
 license = "MIT"
 readme = "../README.md"
-description = "A crate for inlining CSS into 'style' HTML attributes."
+description = "High-performance library for inlining CSS into HTML 'style' attributes"
 repository = "https://github.com/Stranger6667/css-inline"
-keywords = ["html", "css", "css-inline", "email"]
+keywords = ["css", "html", "email", "stylesheet", "inlining"]
 exclude = [".github", ".pre-commit-config.yaml", ".yamllint", ".gitignore", "tests"]
 categories = ["web-programming"]
 rust-version = "1.60"

css-inline/src/main.rs

@@ -26,7 +26,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         r#"
 Dmitry Dygalo <[email protected]>
 
-css-inline inlines CSS into HTML documents.
+css-inline inlines CSS into HTML 'style' attributes.
 
 USAGE:
    css-inline [OPTIONS] [PATH ...]
@@ -46,6 +46,9 @@ OPTIONS:
     --keep-style-tags
         Keep "style" tags after inlining.
 
+    --keep-link-tags
+        Keep "link" tags after inlining.
+
     --base-url
         Used for loading external stylesheets via relative URLs.