Update documentation

Author: Borewit

README.md

@@ -10,6 +10,8 @@
 
 # readable-web-stream-to-node
 
+Converts a [Web-API readable stream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader) into a [Node readable stream](https://nodejs.org/api/stream.html#stream_readable_streams).
+
 ### Installation
 Install via [npm](http://npmjs.org/):
 
@@ -21,18 +23,46 @@ or yarn
 yarn add readable-web-to-node-stream
 ```
 
-### Import music-metadata
+## Examples
+
+### Example written in JavaScript
 
-This is how you can import music-metadata in JavaScript, in you code:
+Import readable-web-stream-to-node in JavaScript:
 ```JavaScript
-var mm = require('readable-web-to-node-stream');
+const ReadableWeToNodeStream = require('readable-web-to-node-stream').ReadableWeToNodeStream;
+
+async function download(url) {
+    const response = await fetch(url);
+    const readableWebStream = response.body;
+    const nodeStream = new ReadableWeToNodeStream(readableWebStream);
+}
+
 ```
 
-This is how it's done in TypeScript:
+### Example written in TypeScript
+
 ```TypeScript
-import * as readableWebToNodeStream from 'readable-web-to-node-stream';
+import { ReadableWeToNodeStream } from 'readable-web-to-node-stream';
+
+async function download(url) {
+  const response = await fetch(url);
+  const readableWebStream = response.body;
+  const nodeStream = new ReadableWeToNodeStream(readableWebStream);
+}
 ```
 
+## API
+
+**constructor(stream: ReadableStream): Promise<void>**
+
+`stream: ReadableStream`: the [Web-API readable stream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader).
+
+**close(): Promise<void>**
+Will cancel close the Readable-node stream, and will release Web-API-readable-stream.
+
+**waitForReadToComplete(): Promise<void>**
+If there is no unresolved read call to Web-API Readable​Stream immediately returns, otherwise it will wait until the read is resolved.
+
 ## Licence
 
 (The MIT License)

src/index.ts

@@ -6,7 +6,8 @@ const debug = initDebug('readable-web-to-node-stream');
 /**
  * Converts a Web-API stream into Node stream.Readable class
  * Node stream readable: https://nodejs.org/api/stream.html#stream_readable_streams
- * Web API readable-stream: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamhttps://nodejs.org/api/stream.html#stream_readable_streams
+ * Web API readable-stream: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
+ * Node readable stream: https://nodejs.org/api/stream.html#stream_readable_streams
  */
 export class ReadableWeToNodeStream extends Readable {
 

tsconfig.json

@@ -19,7 +19,6 @@
     "paths": {
       "stream": [ "readable-stream" ],
       "assert": [ "assert" ]
-
     }
   }
 }