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

updated readme

Browse Source
This commit is contained in:
Dolan
2017-03-07 14:42:48 +00:00
parent 025fa85eba
commit ac636cddb4
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,6 @@
# [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> A tool to create Word Documents (.docx) with JS
> A tool to create Word Documents (.docx) with JS or TS, written in TS.
[![NPM](https://nodei.co/npm/docx.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/docx/)
@ -47,14 +47,16 @@ $ npm install --save docx
# Usage
```js
var officeClippy = require('docx');
// Used to create docx files
var docx = require('docx');
// Used to export the file into a .docx file
// var exporter = officeClippy.exporter;
// Create document
var doc = new docx.Document();
// Used to export the file into a .docx file
// res is express' Response object
var exporter = new docx.ExpressPacker(doc, res);
var exporter = new docx.LocalPacker(doc);
```
## Create simple Word Document
```js
@ -360,6 +362,8 @@ Would produce:
***5th Dec 2015***
Made with 💖 by Dolan Miu 🍆 💦 😝
# License
MIT © [Dolan Miu](http://www.dolan.bio)