update readme

fourcels · Dec 17, 2024 · b2c1aab · b2c1aab
1 parent f24aab5
commit b2c1aab
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -4,9 +4,7 @@
 
 A image upload component for React
 
-## Documentation
-
-Visit [https://github.com/fourcels/react-image-upload](https://github.com/fourcels/react-image-upload) to view the full documentation.
+Visit [react-image-upload](https://fourcels.github.io/react-image-upload/) to view the documentation and examples.
 
 ## Getting Started
 

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,12 @@
 # docs
 
+## 0.0.7
+
+### Patch Changes
+
+- Updated dependencies
+  - @fourcels/react-image-upload@0.5.10
+
 ## 0.0.6
 
 ### Patch Changes

diff --git a/docs/docs/api.mdx b/docs/docs/api.mdx
@@ -5,21 +5,21 @@ sidebar_position: 2
 
 ## ImageUploadProps
 
-| Name               | Type                                                 | Default                                   |
-| ------------------ | ---------------------------------------------------- | ----------------------------------------- |
-| children           | React.ReactNode                                      |                                           |
-| width              | `number`                                             | 100                                       |
-| height             | `number`                                             | `width`                                   |
-| value              | `string` \| `ValueItem` \| `(string \| ValueItem)[]` | []                                        |
-| onChange           | (value: `ImageItem[]`) => void                       |                                           |
-| onUpload           | (file: `File`) => `string` \| `Promise<string>`      | (file: File) => URL.createObjectURL(file) |
-| max                | `number`                                             | Infinity                                  |
-| readonly           | `boolean`                                            |                                           |
-| className          | `string`                                             |                                           |
-| itemClassName      | `string`                                             |                                           |
-| dropzoneClassName  | `string`                                             |                                           |
-| dropzoneOptions    | DropzoneOptions                                      |                                           |
-| photoProviderProps | Omit\<PhotoProviderProps, "children"\>               |                                           |
+| Name               | Description                             | Type                                                 | Default                                   |
+| ------------------ | --------------------------------------- | ---------------------------------------------------- | ----------------------------------------- |
+| children           | custom upload zone                      | React.ReactNode                                      |                                           |
+| width              | image width                             | `number`                                             | 100                                       |
+| height             | image height                            | `number`                                             | `width`                                   |
+| value              | default images                          | `string` \| `ValueItem` \| `(string \| ValueItem)[]` | []                                        |
+| onChange           | callback for when the images changes    | (value: `ImageItem[]`) => void                       |                                           |
+| onUpload           | callback for when the drop event occurs | (file: `File`) => `string` \| `Promise<string>`      | (file: File) => URL.createObjectURL(file) |
+| max                | max image number                        | `number`                                             | Infinity                                  |
+| readonly           | for preview                             | `boolean`                                            |                                           |
+| className          | root className                          | `string`                                             |                                           |
+| itemClassName      | image className                         | `string`                                             |                                           |
+| dropzoneClassName  | dropzone className                      | `string`                                             |                                           |
+| dropzoneOptions    |                                         | DropzoneOptions                                      |                                           |
+| photoProviderProps |                                         | Omit\<PhotoProviderProps, "children"\>               |                                           |
 
 ### Types
 

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

diff --git a/packages/react-image-upload/CHANGELOG.md b/packages/react-image-upload/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @fourcels/react-image-upload
 
+## 0.5.10
+
+### Patch Changes
+
+- update readme
+
 ## 0.5.9
 
 ### Patch Changes

diff --git a/packages/react-image-upload/README.md b/packages/react-image-upload/README.md
@@ -2,11 +2,9 @@
 
 [![NPM version][npm-image]][npm-url]
 
-A image upload component for React base on
+A image upload component for React
 
-## Documentation
-
-Visit [https://github.com/fourcels/react-image-upload](https://github.com/fourcels/react-image-upload) to view the full documentation.
+Visit [react-image-upload](https://fourcels.github.io/react-image-upload/) to view the documentation and examples.
 
 ## Getting Started
 

diff --git a/packages/react-image-upload/package.json b/packages/react-image-upload/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@fourcels/react-image-upload",
-  "version": "0.5.9",
+  "version": "0.5.10",
   "type": "module",
   "description": "A image upload component for React",
   "main": "./dist/index.js",