update changelog and readme

Author: rasimandiran

CHANGELOG.md

@@ -0,0 +1,12 @@
+# react-file-trap changelog
+
+## v1.0.1
+
+- [Added default values for props. This was cause errors when allowedExtensions prop is not provided](https://github.com/rasimandiran/react-file-trap/commit/7b0b3bf1db94faa6ba05047d21e3ca86e0ebcd64)
+- [onClick event handler checked before bind. This was cause errors when browseOnClick prop is false but manual triggering element inside of the trap](https://github.com/rasimandiran/react-file-trap/commit/2017715a48ca41123b45e14f1463303a0813bcd7)
+- [Added a new funtion to remove specific files from file list](https://github.com/rasimandiran/react-file-trap/commit/d6fd3cc9e6f868a27810ae099e6167656698538e)
+- [Page title of the example application is updated](https://github.com/rasimandiran/react-file-trap/commit/48d9b5153c3c534450a2bcd602d92cc46c2be446)
+
+## v1.0.0
+
+- Initial release

README.md

@@ -40,20 +40,92 @@ npm install react-file-trap
 
 ## Props
 
-| Parameter | Type     | Description                |
-| :-------- | :------- | :------------------------- |
-| `ref` | `ref` | Suggest to use to reset and/or trigger browse outside of child component |
-| `allowedExtensions` | `array` | Allowed file extensions |
-| `handleChange` | `function` | Runs when selected and/or dropped a valid file |
-| `handleDrag` | `function` | Runs for every drag event. Possible values: `dragover` `dragleave` |
-| `handleDrop` | `function` | Runs when dropped a file |
-| `onValidationError` | `function` | Runs everytime if dropped or selected file invalid |
-| `fileCount` | `number` | Allowed file count |
-| `maxFileSize` | `number` | Allowed upper limit for file size in MB |
-| `minFileSize` | `number` | Allowed lower limit for file size in MB |
-| `browseOnClick` | `boolean` | Trigger browse window on click to child component |
-
-For more details about usage, please check example project in the root directory.
+| Parameter | Type     | Description                | Default Value     | Notes     |
+| :-------- | :------- | :------------------------- |:----------------- |:--------- |
+| `ref` | `ref` | Suggest to use to reset and/or trigger browse outside of child component | `undefined` | Should be defined to trigger some [functions](https://github.com/rasimandiran/react-file-trap#functions)|
+| `allowedExtensions` | `array` | Allowed file extensions | `undefined` | Don't provide to allow all file types |
+| `handleChange` | `function` | Runs when selected and/or dropped a valid file | | Mandatory prop to handle files. See [events](https://github.com/rasimandiran/react-file-trap#events) |
+| `handleDrag` | `function` | Runs for every drag event. Possible values: `dragover` `dragleave` | `undefined` | See [events](https://github.com/rasimandiran/test/tree/main#events) |
+| `handleDrop` | `function` | Runs when dropped a file | `undefined` | See [events](https://github.com/rasimandiran/react-file-trap#events) |
+| `onValidationError` | `function` | Runs everytime if dropped or selected file invalid | `undefined` | See [events](https://github.com/rasimandiran/react-file-trap#events) |
+| `fileCount` | `number` | Allowed file count | `Number.MAX_VALUE` | |
+| `maxFileSize` | `number` | Allowed upper limit for file size in MB | `Number.MAX_VALUE` | |
+| `minFileSize` | `number` | Allowed lower limit for file size in MB | `0` | |
+| `browseOnClick` | `boolean` | Trigger browse window on click to child component | `true` | |
+
+## Events
+
+### handleChange
+
+Runs on every change on the valid files. `fileList` parameter includes all valid files.
+
+```javascript
+const handleChange = (fileList) => {
+    setFiles(filesList);
+    setTotalSize(byteFormatter(newFiles.reduce((acc, file) => acc + file.size, 0)));
+};
+```
+
+### handleDrag
+
+Runs on drag event, eventName parametet can be: `dragover` or `dragleave`
+
+```javascript
+const handleDrag = (eventName) => {
+    setCurrentEvent(eventName);
+};
+```
+
+### handleDrop
+
+Runs after a dropped files.
+
+```javascript
+const handleDrop = () => {
+    setCurrentEvent('dropped');
+};
+```
+
+### onValidationError
+
+Runs after selected/dropped files.
+
+```javascript
+const onValidationError = (invalidFileList, errorMsg) => {
+    setInvalidFiles([...invalidFiles, ...invalidFileList]);
+    setLastError(errorMsg);
+}
+```
+
+## Functions
+
+### browseFiles
+
+Trigger browse window manually. `ref` prop is needed.
+
+```javascript
+wrapperRef.current.browseFiles();
+```
+
+### resetWrapper
+
+To reset selected files. `ref` prop is needed.
+
+```javascript
+wrapperRef.current.resetWrapper();
+```
+
+### removeFile
+
+To remove specific file. `file` should be provided as parameter. `ref` prop is also needed.
+
+```javascript
+wrapperRef.current.removeFile(file);
+```
+
+## Notes
+
+For more details about usage, please check `example` project in the root directory.
 
 ## License