docx-plus 0.1.7 → 0.3.0

package/README.md

@@ -1,13 +1,14 @@
 # docx-plus
 
-[![NPM version][npm-image]][npm-url]
-[![Downloads per month][downloads-image]][downloads-url]
-[![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
-[![PRs Welcome][pr-image]][pr-url]
+![npm version](https://img.shields.io/npm/v/docx-plus)
+![npm downloads](https://img.shields.io/npm/dw/docx-plus)
+![npm license](https://img.shields.io/npm/l/docx-plus)
 
-Easily generate and modify .docx files with JS/TS. Works for Node and on the Browser.
+> Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.
 
-**docx-plus** is an enhanced fork of [docx](https://github.com/dolanmiu/docx) — a TypeScript/JavaScript library for generating and modifying Word documents (.docx) programmatically with a declarative API.
+**docx-plus** is an enhanced fork of [docx](https://github.com/dolanmiu/docx) by Dolan Miu — a TypeScript/JavaScript library for generating and modifying Word documents (.docx) programmatically with a declarative API. We extend our sincere gratitude to the original author and all contributors for their foundational work.
+
+This package re-exports everything from `@office-open/docx` for backward compatibility. If you are starting a new project, we recommend using `@office-open/docx` directly.
 
 ## What's Different from docx?
 
@@ -46,7 +47,7 @@ Easily generate and modify .docx files with JS/TS. Works for Node and on the Bro
 | Math advanced           | Basic math only                                                            | **Complete** (box, borderBox, eqArr, groupChr, matrix, phant, accent, fraction, nAry, func, delim, bar, limLow, limUpp, sPre, sSub, sSup)         |
 | Group Shape             | Basic (transform only)                                                     | **Enhanced** (fill, effects, `chOff`/`chExt` child coordinates)                                                                                   |
 | Test environment        | jsdom                                                                      | happy-dom                                                                                                                                         |
-| OOXML compliance        | ECMA-376 (legacy)                                                          | **ISO/IEC 29500-4** (latest) — comprehensive WordprocessingML, DrawingML, and Shared Math coverage; see scope notes below                         |
+| OOXML compliance        | ECMA-376 (legacy)                                                          | **ISO/IEC 29500-4** (latest) — comprehensive WordprocessingML, DrawingML, and Shared Math coverage                                                |
 
 ## OOXML Coverage
 
@@ -63,21 +64,19 @@ Easily generate and modify .docx files with JS/TS. Works for Node and on the Bro
 
 ## Installation
 
-```terminal
-npm install --save docx-plus
-```
+```bash
+# Install with npm
+$ npm install docx-plus
 
-```ts
-import * as docx from "docx-plus";
-// or
-import { Document, Packer, Paragraph, TextRun } from "docx-plus";
+# Install with pnpm
+$ pnpm add docx-plus
 ```
 
-## Quick Example
+## Quick Start
 
-```ts
-import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "docx-plus";
+```typescript
+import { Document, Paragraph, TextRun, Packer } from "docx-plus";
+import { writeFileSync } from "node:fs";
 
 const doc = new Document({
     sections: [
@@ -98,28 +97,13 @@ const doc = new Document({
 });
 
 const buffer = await Packer.toBuffer(doc);
-fs.writeFileSync("My Document.docx", buffer);
+writeFileSync("My Document.docx", buffer);
 ```
 
-## Documentation
-
-Please refer to the [documentation](https://github.com/DemoMacro/docx-plus#readme) for details on how to use this library, examples and much more!
-
 ## Examples
 
-Check the [demo folder](https://github.com/DemoMacro/docx-plus/tree/master/demo) for 110+ working examples covering every feature.
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit pull requests.
+Check the [demo folder](../docx/demo) for 100+ working examples covering every feature.
 
----
+## License
 
-[npm-image]: https://badge.fury.io/js/docx-plus.svg
-[npm-url]: https://npmjs.org/package/docx-plus
-[downloads-image]: https://img.shields.io/npm/dm/docx-plus.svg
-[downloads-url]: https://npmjs.org/package/docx-plus
-[github-actions-workflow-image]: https://github.com/DemoMacro/docx-plus/workflows/Default/badge.svg?branch=main
-[github-actions-workflow-url]: https://github.com/DemoMacro/docx-plus/actions
-[pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
-[pr-url]: http://makeapullrequest.com
+- [MIT](LICENSE) © [Demo Macro](https://imst.xyz/)