diff --git a/README.md b/README.md index bdfb4e6388..a6fc7b23b2 100644 --- a/README.md +++ b/README.md @@ -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)