Improve README
This commit is contained in:
20
README.md
20
README.md
@ -3,7 +3,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
Generate .docx files with JS/TS very easily, written in TS.
|
||||
Easily generate .docx files with JS/TS.
|
||||
</p>
|
||||
|
||||
---
|
||||
@ -19,13 +19,9 @@
|
||||
|
||||
# docx
|
||||
|
||||
<p align="center">
|
||||
<img src="https://thumbs.gfycat.com/ComplexEminentEquine-size_restricted.gif" alt="drawing" width="800"/>
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
$ npm install --save docx
|
||||
```
|
||||
</p>
|
||||
|
||||
## 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 💖
|
||||
|
@ -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 💖
|
||||
|
Reference in New Issue
Block a user