fix: create readme.md

This commit is contained in:
Andrey Ponomarenko 2020-09-25 11:52:24 +03:00
parent 34eeaf18b7
commit cd7c2b713e
1 changed files with 34 additions and 0 deletions

34
readme.md Normal file
View File

@ -0,0 +1,34 @@
# diawi-nodejs-uploader
A NodeJS tool for [Diawi](diawi.com) integration written with [Typescript](https://www.typescriptlang.org/)
## Installation
```sh
$ yarn add diawi-nodejs-uploader
=== or ===
$ npm install diawi-nodejs-uploader
```
## Usage
#### Programmatic
All options exept token and file are optional.
```js
import { upload } from 'diawi-nodejs-uploader';
await upload({
file,
token,
}, {
onStatusProgress: console.log,
onUploadProgress: console.log,
})
```
#### CLI
```js
// in development
```