From b874ccda63121e75ff220d7ef6c0a4c1898b260d Mon Sep 17 00:00:00 2001 From: papb Date: Sun, 15 Mar 2020 16:06:07 -0300 Subject: [PATCH] docs: improve readme --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index c6ae353..3e26d20 100644 --- a/readme.md +++ b/readme.md @@ -6,7 +6,7 @@ * Written in TypeScript * Cross-platform -* [Simple API](https://github.com/papb/zip#api), for your simple zipping needs +* [Simple Promise-based API](https://github.com/papb/zip#api), for your simple zipping needs * No external binaries needed @@ -33,7 +33,7 @@ const { zip, zipContents, unzip } = require('@papb/zip'); ## TypeScript usage -@papb/zip is written in TypeScript and comes with complete type declarations. This means that you will have great code completions right in your editor, and also means that you can use Tory perfectly with TypeScript: +@papb/zip is written in TypeScript and comes with complete type declarations. This means that you will have great code completions right in your editor, and also means that you can use it perfectly with TypeScript: ```ts import { zip, zipContents, unzip } from '@papb/zip';