chore: remove cargo-sync-readme

Author: imbolc

.github/workflows/ci.yml

@@ -112,20 +112,3 @@ jobs:
 
       - name: Check unused Cargo dependencies
         run: cargo shear
-
-  readme:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-
-      - name: Install `cargo-sync-readme`
-        uses: actions-rs/install@v0.1
-        with:
-          crate: cargo-sync-readme
-          version: latest
-
-      - name: Is readme in sync?
-        run: cargo sync-readme -c

README.md

@@ -4,8 +4,6 @@
 
 # tower-cookies
 
-<!-- cargo-sync-readme start -->
-
 A cookie manager middleware built on top of [tower].
 
 ## Example
@@ -43,43 +41,14 @@ A complete CRUD cookie example in [examples/counter.rs][example]
 [tower]: https://crates.io/crates/tower
 [example]: https://github.com/imbolc/tower-cookies/blob/main/examples/counter.rs
 
-<!-- cargo-sync-readme end -->
-
-## Safety
-
-This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in
-100% safe Rust.
-
 ## Contributing
 
 Please run [.pre-commit.sh] before sending a PR, it will check everything.
 
-### Note on README
-
-Most of the readme is automatically copied from the crate documentation by
-[cargo-sync-readme][]. This way the readme is always in sync with the docs and
-examples are tested.
-
-So if you find a part of the readme you'd like to change between
-`<!-- cargo-sync-readme start -->` and `<!-- cargo-sync-readme end -->` markers,
-don't edit `README.md` directly, but rather change the documentation on top of
-`src/lib.rs` and then synchronize the readme with:
-
-```bash
-cargo sync-readme
-```
-
-(make sure the cargo command is installed):
-
-```bash
-cargo install cargo-sync-readme
-```
-
 ## License
 
 This project is licensed under the [MIT license][license].
 
 [.pre-commit.sh]:
   https://github.com/imbolc/tower-cookies/blob/main/.pre-commit.sh
-[cargo-sync-readme]: https://github.com/phaazon/cargo-sync-readme
 [license]: https://github.com/imbolc/tower-cookies/blob/main/LICENSE

src/lib.rs

@@ -1,43 +1,5 @@
-//! A cookie manager middleware built on top of [tower].
-//!
-//! ## Example
-//!
-//! With [axum]:
-//!
-//! ```rust,no_run
-//! use axum::{routing::get, Router};
-//! use std::net::SocketAddr;
-//! use tower_cookies::{Cookie, CookieManagerLayer, Cookies};
-//!
-//! # #[cfg(feature = "axum-core")]
-//! #[tokio::main]
-//! async fn main() {
-//!     let app = Router::new()
-//!         .route("/", get(handler))
-//!         .layer(CookieManagerLayer::new());
-//!
-//!     let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
-//!     let listener = tokio::net::TcpListener::bind(&addr).await.unwrap();
-//!     axum::serve(listener, app.into_make_service())
-//!         .await
-//!         .unwrap();
-//! }
-//! # #[cfg(not(feature = "axum-core"))]
-//! # fn main() {}
-//!
-//! async fn handler(cookies: Cookies) -> &'static str {
-//!     cookies.add(Cookie::new("hello_world", "hello_world"));
-//!
-//!     "Check your cookies."
-//! }
-//! ```
-//!
-//! A complete CRUD cookie example in [examples/counter.rs][example]
-//!
-//! [axum]: https://crates.io/crates/axum
-//! [tower]: https://crates.io/crates/tower
-//! [example]: https://github.com/imbolc/tower-cookies/blob/main/examples/counter.rs
-
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![doc = include_str!("../README.md")]
 #![warn(clippy::all, missing_docs, nonstandard_style, future_incompatible)]
 #![forbid(unsafe_code)]
 #![cfg_attr(docsrs, feature(doc_cfg))]