Skip to content

Commit 23a6334

Browse files
JinSSJ3JinSSJ3
committed
[FEAT]: Improve readme file
1 parent dfd2270 commit 23a6334

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Yes, it's really all you need to get started as you can see in these live and in
105105
| footer | `boolean` | `true` | if true, shows the dropzone footer |
106106
| header | `boolean` | `true` | if true, shows the dropzone header |
107107
| label | `string` | "Drop your files here" | Label to place when no files selected |
108-
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN_en"` \| `"ES-es"` | `"EN_en"` | The language to present labels. Only English and Spanish are suported for now. |
108+
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN-en"` \| `"ES-es"` | `"EN-en"` | The language to present labels. Only English and Spanish are suported for now. |
109109
| method | `"POST"` \| `"PUT"` \| `"PATCH"` | `"POST"` | The method for uploading. |
110110
| maxFiles | `number` | 7 | Max `number` of files to be accepted. If the value is 1, will click event dialog to allow just asingle file |
111111
| maxFileSize | `number` | `undefined` | max file size allowed in bytes. if not preent, will not be considered on validating the file |
@@ -129,7 +129,7 @@ Yes, it's really all you need to get started as you can see in these live and in
129129
| hd | `boolean` | `undefined` | If present, preview on full screen will be presented in the real image resolution |
130130
| id | `string` \| `number` | `undefined` | identifier for the file |
131131
| info | `boolean` | `false` | If present, the info layer and the info button will ve visible |
132-
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN_en"` \| `"ES-es"` | `"EN-en"` | The language to present labels. Only English and Spanish are suported for now. |
132+
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN-en"` \| `"ES-es"` | `"EN-en"` | The language to present labels. Only English and Spanish are suported for now. |
133133
| onDelete | `Function` | `undefined` | A `Function` of what to do when close button is pressed or clicked |
134134
| onSee | `Function` | `undefined` | A `Function` of what to do when "see" button is pressed or clicked. Returns as first parameter the image url. If `hd` present, will return the image url in the real quality. Otherwise, will return a minimized image with less resolution in order to save memory. |
135135
| preview | `boolean` | `false` | If present, and if `onSee` present, "see" button will be visible and on click will trigger `onSee` function |

‎README_ES.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
</p>
99

10-
Dropzone UI es un pequeño set de componentes [React](https://reactjs.org/) para manejar cargas de archivo y vista previa de imágenes en la interfaz gráfica. Componentes fueron hechos inspirados en otras librerias existentes (sin embargo, estas **no** son dependencias , ya que la idea es tomar como **referencia** varias librerias buenas y **crear** algo **nuevo**). Pricipios de Material Design de Google fueron considerados en el desarrollo. De hecho, todos los iconos son [Material design icons](https://fonts.google.com/icons).
10+
Dropzone UI es un pequeño set de componentes [React](https://reactjs.org/) para manejar cargas de archivo y vista previa de imágenes en la interfaz gráfica. Componentes fueron hechos inspirados en otras librerias existentes (sin embargo, estas **no** son dependencias , ya que la idea es tomar como **referencia** varias librerias buenas y **crear** algo **nuevo**). Principios de Google Material Design fueron considerados en el desarrollo. De hecho, todos los iconos son [Material design icons](https://fonts.google.com/icons).
1111

1212
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dropzone-ui/dropzone-ui/blob/HEAD/LICENSE)
1313
[![npm latest package](https://img.shields.io/npm/v/dropzone-ui.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/dropzone-ui)
@@ -104,7 +104,7 @@ Si, esto es todo lo que necesitas para iniciarte como puedes observar en estos d
104104
| footer | `boolean` | `true` | Si es verdadero, muestra el footer del componente |
105105
| header | `boolean` | `true` | Si es verdadero, muestra el la cabecera del componente |
106106
| label | `string` | "Drop your files here" | Etiqueta o texto a mostrar cuando no hay archivos soltados o seleccionados |
107-
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN-en"` \| `"ES-es"` | `"EN-en"` | El idioma en el cual se presentan las etiuquetas. Solo están soportados `ingles` y `español` por ahora. |
107+
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN-en"` \| `"ES-es"` | `"EN-en"` | El idioma en el cual se presentan las etiquetas. Solo están soportados `ingles` y `español` por ahora. |
108108
| method | `"POST"` \| `"PUT"` \| `"PATCH"` | `"POST"` | El tipo de método HTTP para subir el archivo |
109109
| maxFiles | `number` | 7 | Max `number` of files to be accepted. If the value is 1, will click event dialog to allow just asingle file |
110110
| maxFileSize | `number` | `undefined` | Tamaño máximo de archivo admitido. Si no esta presente, no será considerado el tamaño del archivo enla validación. |
@@ -128,7 +128,7 @@ Si, esto es todo lo que necesitas para iniciarte como puedes observar en estos d
128128
| hd | `boolean` | `undefined` | Si está presente, la vista previa en pantalla completa será presentada en la resolución real de la imagen |
129129
| id | `string` \| `number` | `undefined` | identificador del archivo |
130130
| info | `boolean` | `false` | Si está presente, el boton de "info" y la capa de información serán visibles. |
131-
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN-en"` \| `"ES-es"` | `"EN-en"` | El idioma en el cual se presentan las etiuquetas. Solo están soportados `ingles` y `español` por ahora. |
131+
| localization [![new-feature](https://img.shields.io/badge/new-feature-green.svg)](https://img.shields.io/badge/new-feature-green) | `"EN-en"` \| `"ES-es"` | `"EN-en"` | El idioma en el cual se presentan las etiquetas. Solo están soportados `ingles` y `español` por ahora. |
132132
| onDelete | `Function` | `undefined` | Una funcion `Function` que describe que hacer cuando el boton "close" ha sido clickeado o presionado. |
133133
| onSee | `Function` | `undefined` | Una función `Function` que describe que hacer cuando el botón "see" es presionado o clickeado. Retorna como primer parámetro la url de la imagen en formato `string`. Si además, el prop `hd` está presente, esta función retornarála url de la imagen en su calidad máxima. De otra forma, retornará una imagen con la resolucion minimizada en aras de mejorar el rendimiento. |
134134
| preview | `boolean` | `false` | Si esta presente, y si `onSee` está presente, el botón "see" será visible y disparaá la función `onSee` |
@@ -177,5 +177,5 @@ Si, esto es todo lo que necesitas para iniciarte como puedes observar en estos d
177177

178178
## License
179179

180-
Este proyecto esta licenciado bajo los terminos de la
180+
Este proyecto está licenciado bajo los terminos de la
181181
[Licencia MIT](/LICENSE).

‎package.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
"typescript",
2929
"unlimited",
3030
"unlimited-react-components",
31+
"front-end",
32+
"framework",
3133
"kamui"
3234
],
3335
"author": "JinSSJ3",

0 commit comments

Comments
 (0)