heading-case 0.0.0 → 0.1.0

package/README.md

@@ -1,5 +1,7 @@
 # heading-case
 
+Format page titles and section headings in markdown files to use [sentence-style capitalization](https://learn.microsoft.com/en-us/style-guide/text-formatting/using-type/use-sentence-style-capitalization).
+
 <p>
   <a href="https://npmjs.com/package/heading-case">
    <img src="https://img.shields.io/npm/v/heading-case?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
@@ -8,6 +10,26 @@
   <a href="https://npmcharts.com/compare/heading-case?minimal=true"><img src="https://img.shields.io/npm/dm/heading-case.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
 </p>
 
+## Example
+
+- Input:
+
+```md
+# A New Method for Creating JavaScript Rollovers
+```
+
+- Output:
+
+```md
+# A new method for creating JavaScript rollovers
+```
+
+## Limitations
+
+This package is designed for Rspack's documentation. It follows the writing style of Rspack documentation and may not work well for other projects.
+
+There are some edge cases that can not be correctly handled, so the execution result is not completely reliable.
+
 ## Usage
 
 Install:
@@ -16,6 +38,12 @@ Install:
 npm add heading-case -D
 ```
 
+Format all markdown and MDX files in the current directory:
+
+```bash
+npx heading-case
+```
+
 ## License
 
 [MIT](./LICENSE).

package/bin.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { headingCase } from './dist/index.js';
+
+headingCase();

package/dist/dict.d.ts

@@ -0,0 +1 @@
+export declare const dict: string[];

package/dist/index.d.ts

@@ -1 +1,4 @@
-export {};
+export declare function globMarkdownFiles(cwd: string): Promise<string[]>;
+export declare function headingCase({ root, }?: {
+    root?: string;
+}): Promise<void>;