mdat 2.3.6 → 3.1.0

package/readme.md

@@ -6,8 +6,8 @@
 
 <!-- badges -->
 
-[![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://npmjs.com/package/mdat)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
+[![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://www.npmjs.com/package/mdat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
 [![CI](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml)
 
 <!-- /badges -->
@@ -103,7 +103,7 @@ The `<!-- title -->` comment was expanded with content derived from your project
 
 ### Dependencies
 
-Node 22+ (specifically `>=22.17.0`). Written in TypeScript with bundled type definitions.
+Node 24+ (specifically `>=24.16.0`). Written in TypeScript with bundled type definitions.
 
 ### Installation
 
@@ -176,7 +176,7 @@ pnpm install --global mdat
    }
    ```
 
-   See the [bundled rules](src/lib/readme/rules) for more complex examples.
+   See the [bundled rules](./src/lib/readme/rules) for more complex examples.
 
    JSON files can also be used as rule sets. MDAT flattens them so any dot-notated key path becomes a comment keyword.
 
@@ -192,7 +192,7 @@ pnpm install --global mdat
 
    Compound rules combine several individual rules into a single comment keyword.
 
-   See [`<!-- header -->`](src/lib/readme/rules/header.ts) for an example.
+   See [`<!-- header -->`](./src/lib/readme/rules/header.ts) for an example.
 
 8. **Polyglot metadata**
 
@@ -531,9 +531,7 @@ type Rule =
   | string
   | {
       content:
-        | ((options: JsonValue, context: RuleContext) => Promise<string> | string)
-        | Rule[]
-        | string
+        ((options: JsonValue, context: RuleContext) => Promise<string> | string) | Rule[] | string
       order?: number
     }
 
@@ -550,7 +548,7 @@ When multiple config files are loaded, they are merged. CLI `--config` takes pre
 
 ### Creating custom rules
 
-See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples) of the `remark-mdat` readme, or look at the [bundled rules](src/lib/readme/rules) for complex examples.
+See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples) of the `remark-mdat` readme, or look at the [bundled rules](./src/lib/readme/rules) for complex examples.
 
 ### Bundled rules
 
@@ -566,7 +564,7 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
 - ##### `<!-- badges -->`
 
-  Generates badges based on project metadata. Supports NPM version, license, and CI status badges.
+  Generates badges based on project metadata. Supports NPM version, license, CI status, and Git LFS badges.
 
 - ##### `<!-- description -->`
 
@@ -580,6 +578,10 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   Documents platform requirements and peer dependencies. Lists runtime platforms (Node, Python, Rust, Go, Ruby, etc.) with version constraints from `engines` or equivalent metadata, supported operating systems, and peer dependencies with links to npm.
 
+- ##### `<!-- development-dependencies -->`
+
+  Documents the tools needed to work on the project itself, derived from the `devEngines` and `packageManager` fields in `package.json`. Lists required runtimes and package managers with links and version constraints. Also aliased as `<!-- dev-dependencies -->`.
+
 - ##### `<!-- table-of-contents -->`
 
   Auto-generated via [mdast-util-toc](https://github.com/syntax-tree/mdast-util-toc). Also aliased as `<!-- toc -->`.