From cd7c2b713e831b0c9410fae1eaa781bf90d57f46 Mon Sep 17 00:00:00 2001
From: Andrey Ponomarenko <slaner2008@yandex.ru>
Date: Fri, 25 Sep 2020 11:52:24 +0300
Subject: [PATCH] fix: create readme.md

---
 readme.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..6ac453a
--- /dev/null
+++ b/readme.md
@@ -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
+```