Skip to content

Commit 914d70b

Browse files
committed
[REF]: Improve Readme.ms
1 parent 5b2ef18 commit 914d70b

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@
1313
[![Total alerts](https://img.shields.io/lgtm/alerts/g/dropzone-ui/dropzone-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/dropzone-ui/dropzone-ui/alerts/)
1414
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/dropzone-ui/dropzone-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/dropzone-ui/dropzone-ui/context:javascript)
1515
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/dropzone-ui/badge.svg)](https://snyk.io/test/github/dropzone-ui/dropzone-ui)
16+
[![](https://data.jsdelivr.com/v1/package/npm/dropzone-ui/badge)](https://www.jsdelivr.com/package/npm/dropzone-ui)
1617
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1718

1819
## Description
1920

20-
Dropzone UI is a mini set of [React](https://reactjs.org/) components for managing file uploads, image previews and all with **little** code needed. Components were made inspired on other existing libraries like [react-dropzone](https://www.npmjs.com/package/react-dropzone) and [dropzonejs](https://www.npmjs.com/package/dropzone). Also, following some of the good google's Material design principles and icons.
21+
Dropzone UI is a mini set of [React](https://reactjs.org/) components for managing file uploads, image previews and all with **little** code needed. Components were made inspired on other existing libraries like [react-dropzone](https://www.npmjs.com/package/react-dropzone) and [dropzonejs](https://www.npmjs.com/package/dropzone) (however, both are **not** dependencies in order avoid increasing the package size and the idea is to **create** something **new** having many good existing libraries only as **reference**). Also, some componetes follows some of the good google's Material design principles. Actually, all the icons involved are google material design icons.
2122

2223
## Sample result:
2324

@@ -164,9 +165,9 @@ Yes, it's really all you need to get started as you can see in these live and in
164165
| multiple | `boolean` | `false` | whether to accept multiple files or not |
165166
| onChange | `Function` | `undefined` | What to do after selecting the files. Returns the File[] to the parent component |
166167
| style | `React.CSSProperties` | {} | the in-line style object |
167-
| text | `"uppercase"` \| `"capitalize"` \| `"lowercase"` \| `"none"` | `"capitalize"` | the text transfor for the button label |
168+
| text | `"uppercase"` \| `"capitalize"` \| `"lowercase"` \| `"none"` | `"capitalize"` | The text transform for the text inside the button label |
168169
| textColor | `string` | "white" | The font color in case variant is `"contained"` |
169-
| validator | (f: `File`) => `boolean` | `undefined` | must be a function that recieves as first parameter a File Object and must return a boolean value. This function will be used instead of the default validator |
170+
| validator | (f: `File`) => `boolean` | `undefined` | Must be a function that recieves as first parameter a File Object and must return a boolean value. This function will be used instead of the default validator |
170171
| variant | `"text"` \| `"outlined"` \| `"contained"` | `"contained"` | The variant of the button |
171172

172173
## License

0 commit comments

Comments
 (0)