From 24a7bf4f4e9305b7a0d55d68d9abc57e49bee4fc Mon Sep 17 00:00:00 2001
From: Nahor <nahor.j+github@gmail.com>
Date: Thu, 7 Mar 2024 12:20:08 -0800
Subject: [PATCH] ci(doc consistency): check that lib.rs and README.md are
 consistent (#353)

---
 .github/workflows/ci.yml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 7ab9326..233b6b4 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -16,6 +16,12 @@ jobs:
         with:
           toolchain: stable
           components: rustfmt
+      - name: Install cargo-readme
+        run: cargo install cargo-readme
+      - name: Check doc consistency
+        shell: bash
+        run: diff -q README.md <(cargo readme)
+            || { echo "::error::Update lib.rs then use cargo-readme to update README.md"; exit 1; }
       - name: rustfmt
         run: cargo fmt --all -- --check
       - name: docs