Skip to content

Commit cde6b2c

Browse files
JinSSJ3JinSSJ3
authored
[REF]: Improve README.me file
1 parent dada1b7 commit cde6b2c

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,12 @@ Yes, it's really all you need to get started as you can see in these live and in
8989
|FileItem with no image preview|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/dropzone-ui-file-item-with-no-image-preview-14i2m) |
9090
|InputFileButton & FileItemContainer|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/inputbutton-example-poqsn?file=/src/App.js)|
9191
|`localización`: multilanguage example|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/localization-6ew1i?file=/src/App.js)|
92-
|Server side example for upload a file | https://github.com/dropzone-ui/file-upload-server-side/tree/main/expressjs |
92+
|Server side example for uploading a file | https://github.com/dropzone-ui/file-upload-server-side/tree/main/expressjs |
9393

9494
# Uploading
95-
Dropzone-ui provides away to upload files to a server. In case you want to make your own upload function, you can take the files that Dropzone `onChange` event returns.
96-
For uploading files through dropzone-ui you should follow some gidelines:
95+
Dropzone-ui provides a way to upload files to a server. In case you want to make your own upload function, you can take the files that Dropzone `onChange` event returns.
96+
97+
For uploading files through dropzone-ui you should follow at least this guidelines:
9798

9899
* Server Endpoint should get the file from `req.files.file`.
99100
* Server Response should follow the [`FileDuiResponse`](#fileduiresponse) structure for returning a response.
@@ -198,9 +199,9 @@ Dropzone-ui is available in different languages. So far, we only support `Englis
198199

199200
### Props
200201

201-
| Name | Type | Default | Description | |
202-
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
203-
| file | `File` | `undefined` | The actual `File` object instance |
202+
| Name | Type | Default | Description |
203+
| ----- | ------- | ----------- | -------------- |
204+
| file | `File` | `undefined` | The actual `File` object instance |
204205
| errors | `string[]` | `undefined` | The list of errors according to the validation criteria or custom validation function given. |
205206
| hd | `boolean` | `undefined` | If present, preview on full screen will be presented in the real image resolution |
206207
| id | `string` \| `number` | `undefined` | identifier for the file |
@@ -325,4 +326,4 @@ export interface CustomValidateFileResponse {
325326
This project is licensed under the terms of the
326327
[MIT license](/LICENSE).
327328

328-
Did you like the project? Please don't forget to give us a :star: star on :octocat: [github](https://github.com/dropzone-ui/dropzone-ui) :D
329+
Did you like the project? Please don't forget to give us a :star: star on :octocat: [github](https://github.com/dropzone-ui/dropzone-ui) :D

0 commit comments

Comments
 (0)