Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
papb committed Mar 15, 2020
1 parent eb77302 commit b874ccd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

* Written in TypeScript
* Cross-platform
* [Simple API](https:/papb/zip#api), for your simple zipping needs
* [Simple Promise-based API](https:/papb/zip#api), for your simple zipping needs
* No external binaries needed


Expand All @@ -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';
Expand Down

0 comments on commit b874ccd

Please sign in to comment.