📝 generate docs

VitorLuizC · May 7, 2020 · ca4b276 · ca4b276
1 parent 424c1f7
commit ca4b276
Showing 1 changed file with 14 additions and 9 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-**[selectFiles](README.md)**
+[selectFiles](README.md)
 
-[Globals](README.md)
+# selectFiles
 
 ## Index
 
@@ -20,7 +20,7 @@
 
 Ƭ **InputFile**: *HTMLInputElement & object*
 
-*Defined in [index.ts:4](https://github.com/VitorLuizC/select-files/blob/e6d7c36/src/index.ts#L4)*
+*Defined in [index.ts:4](https://github.com/VitorLuizC/select-files/blob/424c1f7/src/index.ts#L4)*
 
 Custom type for file input element (`<input type="file" />`).
 
@@ -30,7 +30,7 @@ ___
 
 Ƭ **Options**: *object*
 
-*Defined in [index.ts:12](https://github.com/VitorLuizC/select-files/blob/e6d7c36/src/index.ts#L12)*
+*Defined in [index.ts:12](https://github.com/VitorLuizC/select-files/blob/424c1f7/src/index.ts#L12)*
 
 Type of options for file input element (`<input type="file" />`) virtually
 created to select files.
@@ -49,18 +49,18 @@ created to select files.
 
 ▸ **createInputFile**(`__namedParameters`: object): *[InputFile](README.md#inputfile)*
 
-*Defined in [index.ts:41](https://github.com/VitorLuizC/select-files/blob/e6d7c36/src/index.ts#L41)*
+*Defined in [index.ts:41](https://github.com/VitorLuizC/select-files/blob/424c1f7/src/index.ts#L41)*
 
 Creates a virtual file input element (`<input type="file" />`) with options.
 
 **Parameters:**
 
-▪`Default value`  **__namedParameters**: *object*=  {}
+▪`Default value`  **__namedParameters**: *object*= {}
 
 Name | Type | Default |
 ------ | ------ | ------ |
 `accept` | string | "" |
-`capture` | string \| false \| true | false |
+`capture` | string &#124; false &#124; true | false |
 `multiple` | boolean | false |
 
 **Returns:** *[InputFile](README.md#inputfile)*
@@ -71,15 +71,20 @@ ___
 
 ▸ **selectFiles**(`options?`: [Options](README.md#options)): *Promise‹null | FileList›*
 
-*Defined in [index.ts:67](https://github.com/VitorLuizC/select-files/blob/e6d7c36/src/index.ts#L67)*
+*Defined in [index.ts:67](https://github.com/VitorLuizC/select-files/blob/424c1f7/src/index.ts#L67)*
 
 Virtually creates a file input element (`<input type="file" />`), triggers it
 and returns selected files.
 
+**`example`** 
+selectFiles({ accept: 'image/*', multiple: true }).then(files => {
+  // ...
+});
+
 **Parameters:**
 
 Name | Type | Description |
 ------ | ------ | ------ |
 `options?` | [Options](README.md#options) |   |
 
-**Returns:** *Promise‹null | FileList›*
+**Returns:** *Promise‹null | FileList›*