From 18d379d5b4a5ed4fa22e8047f4751279c9212f23 Mon Sep 17 00:00:00 2001
From: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
Date: Tue, 2 Apr 2024 04:33:18 +0900
Subject: [PATCH] docs: Add example of how to use textlint-filter-rule-comments
 to README

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 00cf3aa..9158a40 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,25 @@ bun add textlint-plugin-mdx
 - `extensions`: `string[]`
   - Additional file extensions for MDX
 
+## Examples
+
+### textlint-filter-rule-comments
+
+Example of how to use [textlint-filter-rule-comments](https://www.npmjs.com/package/textlint-filter-rule-comments) is shown below. There is no need to use syntax such as `{/* <!-- textlint-disable --> */}`.
+
+```mdx
+This is error text.
+
+{/* textlint-disable */}
+
+This is ignored text by rule.
+Disables all rules between comments
+
+{/* textlint-enable */}
+
+This is error text.
+```
+
 ## Contributing
 
 1. Fork it!