diff --git a/README.md b/README.md index a24abcc0a7..f102c85f7e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

- Generate .docx files with JS/TS very easily, written in TS. + Easily generate .docx files with JS/TS.

--- @@ -19,13 +19,9 @@ # docx -drawing - -## Install - -```sh -$ npm install --save docx -``` +

+ drawing +

## Demo @@ -57,18 +53,12 @@ Please refer to [https://docx.js.org/](https://docx.js.org/) for details on how ## Examples -Check the examples section in the [documentation](https://docx.js.org/#/examples) and the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples. +Check the `examples` section in the [documentation](https://docx.js.org/#/examples) and the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples. -# Contributing +## Contributing Read the contribution guidelines [here](https://docx.js.org/#/contribution-guidelines). -# Honoured Mentions - -[@felipeochoa](https://github.com/felipeochoa) - -[@h4buli](https://github.com/h4buli) - --- Made with 💖 diff --git a/docs/README.md b/docs/README.md index 2ea6ac25e3..557bcbad65 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,11 +19,11 @@ npm install --save docx Then you can `require` or `import` as usual: ```js -let docx = require('docx'); +let docx = require("docx"); ``` ```js -import * as docx from 'docx' +import * as docx from "docx"; ``` ## Basic Usage @@ -48,6 +48,12 @@ exporter.pack("My First Document"); // Done! A file called 'My First Document.docx' will be in your file system if you used LocalPacker ``` +## Honoured Mentions + +[@felipeochoa](https://github.com/felipeochoa) + +[@h4buli](https://github.com/h4buli) + --- Made with 💖