docs: Reuse README.md in crate's docs

Stranger6667 · Stranger6667 · commit d944ccdac9dd · 2022-01-09T23:35:18.000+01:00
diff --git a/README.md b/README.md
@@ -38,13 +38,11 @@ To use it in your project add the following line to your `dependencies` section
 css-inline = "0.7"
 ```
 
-Minimum Supported Rust Version is 1.53.
+Minimum Supported Rust Version is 1.54.
 
 ## Usage
 
 ```rust
-use css_inline;
-
 const HTML: &str = r#"<html>
 <head>
     <title>Test</title>
@@ -67,7 +65,7 @@ fn main() -> Result<(), css_inline::InlineError> {
 `css-inline` can be configured by using `CSSInliner::options()` that implements the Builder pattern:
 
 ```rust
-use css_inline;
+const HTML: &str = "...";
 
 fn main() -> Result<(), css_inline::InlineError> {
     let inliner = css_inline::CSSInliner::options()
@@ -93,8 +91,8 @@ There are bindings for Python and WebAssembly in the `bindings` directory.
 
 `css-inline` provides a command-line interface:
 
-```
-$ css-inline --help
+```text
+css-inline --help
 
 css-inline inlines CSS into HTML documents.
 
@@ -104,17 +102,20 @@ USAGE:
 
 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 "inlined." prefix. E.g., for "example.html", there will be
-        "inlined.example.html".
+        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 "inlined." prefix. E.g., for "example.html", there
+        will be "inlined.example.html".
 
 OPTIONS:
     --inline-style-tags
-        Whether to inline CSS from "style" tags. The default value is `true`. To disable inlining
-        from "style" tags use `--inline-style-tags=false`.
+        Whether to inline CSS from "style" tags. The default
+        value is `true`. To disable inlining from "style" tags
+        use `--inline-style-tags=false`.
 
     --remove-style-tags
         Remove "style" tags after inlining.
diff --git a/bindings/python/README.md b/bindings/python/README.md
@@ -28,7 +28,7 @@ pip install css_inline
 ```
 
 Pre-compiled wheels for most popular platforms are provided. If your platform is not in the support table below, you will need
-a Rust compiler to build this package from source. The minimum supported Rust version is 1.53.
+a Rust compiler to build this package from source. The minimum supported Rust version is 1.54.
 
 Usage
 -----
diff --git a/bindings/python/setup.py b/bindings/python/setup.py
@@ -43,7 +43,7 @@ def call_setup():
                     if platform.python_implementation() == "PyPy"
                     else ["pyo3/abi3-py36"]
                 ),
-                rust_version=">=1.53.0",
+                rust_version=">=1.54.0",
             )
         ],
         classifiers=[
diff --git a/css-inline/src/lib.rs b/css-inline/src/lib.rs
@@ -1,84 +1,4 @@
-//! # css-inline
-//!
-//! A crate for inlining CSS into HTML documents. When you send HTML emails, you need to use "style"
-//! attributes instead of "style" tags.
-//!
-//! For example, this HTML:
-//!
-//! ```html
-//! <html>
-//!     <head>
-//!         <title>Test</title>
-//!         <style>h1 { color:blue; }</style>
-//!     </head>
-//!     <body>
-//!         <h1>Big Text</h1>
-//!     </body>
-//! </html>
-//! ```
-//!
-//! Will be turned into this:
-//!
-//! ```html
-//! <html>
-//!     <head><title>Test</title></head>
-//!     <body>
-//!         <h1 style="color:blue;">Big Text</h1>
-//!     </body>
-//! </html>
-//! ```
-//!
-//! ## Usage
-//!
-//! ```rust
-//! const HTML: &str = r#"<html>
-//! <head>
-//!     <title>Test</title>
-//!     <style>h1 { color:blue; }</style>
-//! </head>
-//! <body>
-//!     <h1>Big Text</h1>
-//! </body>
-//! </html>"#;
-//!
-//!fn main() -> Result<(), css_inline::InlineError> {
-//!    let inlined = css_inline::inline(HTML)?;  // shortcut with default options
-//!    // Do something with inlined HTML, e.g. send an email
-//!    Ok(())
-//! }
-//! ```
-//!
-//! ### Features & Configuration
-//!
-//! `css-inline` can be configured by using `CSSInliner::options()` that implements the Builder pattern:
-//!
-//! ```rust
-//! const HTML: &str = r#"<html>
-//! <head>
-//!     <title>Test</title>
-//!     <style>h1 { color:blue; }</style>
-//! </head>
-//! <body>
-//!     <h1>Big Text</h1>
-//! </body>
-//! </html>"#;
-//!
-//! fn main() -> Result<(), css_inline::InlineError> {
-//!     let inliner = css_inline::CSSInliner::options()
-//!         .load_remote_stylesheets(false)
-//!         .build();
-//!     let inlined = inliner.inline(HTML);
-//!     // Do something with inlined HTML, e.g. send an email
-//!     Ok(())
-//! }
-//! ```
-//!
-//! - `inline_style_tags`. Whether to inline CSS from "style" tags. Default: `true`
-//! - `remove_style_tags`. Remove "style" tags after inlining. Default: `false`
-//! - `base_url`. Base URL to resolve relative URLs. Default: `None`
-//! - `load_remote_stylesheets`. Whether remote stylesheets should be loaded or not. Default: `true`
-//! - `extra_css`. Additional CSS to inline. Default: `None`
-//!
+#![doc = include_str!("../../README.md")]
 #![warn(
     clippy::doc_markdown,
     clippy::redundant_closure,

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ def call_setup():`
`43`	`43`	`if platform.python_implementation() == "PyPy"`
`44`	`44`	`else ["pyo3/abi3-py36"]`
`45`	`45`	`),`
`46`		`- rust_version=">=1.53.0",`
	`46`	`+ rust_version=">=1.54.0",`
`47`	`47`	`)`
`48`	`48`	`],`
`49`	`49`	`classifiers=[`