smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve README

Browse Source
This commit is contained in:
Dolan
2018-08-09 03:13:16 +01:00
parent 94274733f4
commit e9ea4845be
2 changed files with 14 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,7 +3,7 @@
</p> </p>
<p align="center"> <p align="center">
Generate .docx files with JS/TS very easily, written in TS. Easily generate .docx files with JS/TS.
</p> </p>
--- ---
@ -19,13 +19,9 @@
# docx # docx
<img src="https://thumbs.gfycat.com/ComplexEminentEquine-size_restricted.gif" alt="drawing" width="800"/> <p align="center">
<img src="https://thumbs.gfycat.com/ComplexEminentEquine-size_restricted.gif" alt="drawing" width="800"/>
## Install </p>
```sh
$ npm install --save docx
```
## Demo ## Demo
@ -57,18 +53,12 @@ Please refer to [https://docx.js.org/](https://docx.js.org/) for details on how
## Examples ## 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). 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 💖 Made with 💖

10
docs/README.md
View File

@ -19,11 +19,11 @@ npm install --save docx
Then you can `require` or `import` as usual: Then you can `require` or `import` as usual:
```js ```js
let docx = require('docx'); let docx = require("docx");
``` ```
```js ```js
import * as docx from 'docx' import * as docx from "docx";
``` ```
## Basic Usage ## 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 // 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 💖 Made with 💖