Skip to content

Commit d413208

Browse files
committed
[REF]: improve readme.md file description and typos
1 parent ed18071 commit d413208

5 files changed

Lines changed: 28 additions & 12 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ node_modules
33
storybook-static
44
#src
55
process.md
6+
7+
Dropzone-ui.txt

.npmignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ README.md
1515
CHANGELOG.md
1616
rollup.config.js
1717
./.travis.yml
18-
tempackage.json
18+
tempackage.json
19+
Dropzone-ui.txt

CHANGELOG.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,17 @@
99

1010
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
1111

12+
<a name="1.2.10"></a>
1213

13-
<a name="1.1.84"></a>
14+
## [1.2.10](https://github.com/glicht/npm-get-version/compare/v1.0.1...v1.0.2) (2021-09-21)
1415

15-
## [1.1.84](https://github.com/glicht/npm-get-version/compare/v1.0.1...v1.0.2) (2021-09-12)
16+
### Features
17+
18+
- Improve Readme.md
19+
- Add quiality badge
20+
<a name="1.2.9"></a>
21+
22+
## [1.2.9](https://github.com/glicht/npm-get-version/compare/v1.0.1...v1.0.2) (2021-09-12)
1623

1724
### Features
1825

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
<p align="center">
22
<img align="center" height="150" src="https://user-images.githubusercontent.com/43678736/132112022-0ca409ae-cca2-43c8-be89-110376260a3f.png" alt="dropone-ui-logo">
33

4-
<h1 align="center"> Dropzone UI </h1>
4+
<h1 align="center"> dropzone-ui </h1>
55

66
</p>
77

88
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dropzone-ui/dropzone-ui/blob/HEAD/LICENSE)
99
[![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)
1010
[![dependencies Status](https://status.david-dm.org/gh/dropzone-ui/dropzone-ui.svg)](https://david-dm.org/dropzone-ui/dropzone-ui)
1111
[![Build Status](https://app.travis-ci.com/dropzone-ui/dropzone-ui.svg?branch=master)](https://app.travis-ci.com/dropzone-ui/dropzone-ui)
12-
[![install size](https://packagephobia.com/badge?p=dropzone-ui)](https://packagephobia.com/result?p=dropzone-ui)
1312
[![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/)
1413
[![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)
1514
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/dropzone-ui/badge.svg)](https://snyk.io/test/github/dropzone-ui/dropzone-ui)
15+
[![Package Quality](https://packagequality.com/shield/dropzone-ui.svg)](https://packagequality.com/#?package=dropzone-ui)
16+
[![install size](https://packagephobia.com/badge?p=dropzone-ui)](https://packagephobia.com/result?p=dropzone-ui)
1617
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1718

1819
## Description
@@ -21,7 +22,9 @@ Dropzone UI is a mini set of [React](https://reactjs.org/) components for managi
2122

2223
## Sample result:
2324

24-
On `Drag`, `Drop` and `Upload`. (also changing view mode from `grid` to `list`)
25+
On `Drag`, `Drop` and `Upload`. (also changing view mode from `grid` to `list`).
26+
27+
Did you like the package? Don't forget to give us a star on [github](https://github.com/dropzone-ui/dropzone-ui) :D
2528

2629
<p align="center">
2730
<img align="center" width="35%" src="https://user-images.githubusercontent.com/43678736/132642335-dc7e7ceb-ae86-4f81-8625-4ee28dc5f593.png" alt="dropone-ui-logo"><img align="center" width="35%" src="https://user-images.githubusercontent.com/43678736/132642336-e295d84d-d950-43b2-b9fc-0529b4ecfe46.png" alt="dropone-ui-logo"><img align="center" width="35%" src="https://user-images.githubusercontent.com/43678736/132642339-2cd996a3-7754-46c9-89ed-56291972154f.png" alt="dropone-ui-logo"><img align="center" width="35%" src="https://user-images.githubusercontent.com/43678736/132642341-b1eb2bfe-8134-4cdf-a808-62b14058b4c1.png" alt="dropone-ui-logo">
@@ -76,7 +79,7 @@ Yes, it's really all you need to get started as you can see in these live and in
7679
|Dropzone Complete example|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/complete-946hz?file=/src/index.js)|
7780
|File item props|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/fileitem-props-o0w5x)|
7881
|No preview FileItem|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/no-preview-14i2m) |
79-
|InputFileButton|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/inputbutton-example-poqsn?file=/src/App.js)|
82+
|InputFileButton & FileItemContainer|[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/inputbutton-example-poqsn?file=/src/App.js)|
8083
|Server side upload file | https://github.com/dropzone-ui/file-upload-server-side/tree/main/expressjs |
8184

8285
# Dropzone UI Components API

package.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dropzone-ui",
3-
"version": "1.2.9",
3+
"version": "1.2.10",
44
"description": "Elegant React Library Component for drag’n’drop files. Simple to use with little code. Also follows material design guidelines.",
55
"main": "./build/index.js",
66
"module": "./build/index.es.js",
@@ -11,22 +11,24 @@
1111
},
1212
"keywords": [
1313
"dropzone",
14-
"material-dropzone",
1514
"react-dropzone",
15+
"material-dropzone",
1616
"dopzone-ui",
1717
"react",
1818
"material",
1919
"dragndrop",
2020
"drag and drop",
2121
"file upload",
22+
"file",
2223
"upload",
2324
"react-component",
2425
"react",
2526
"drag",
2627
"drop",
2728
"typescript",
2829
"unlimited",
29-
"unlimited-react-components"
30+
"unlimited-react-components",
31+
"kamui"
3032
],
3133
"author": "JinSSJ3",
3234
"license": "MIT",
@@ -42,7 +44,8 @@
4244
"peerDependencies": {
4345
"axios": "^0.21.4",
4446
"react": "^17.0.2",
45-
"react-dom": "^17.0.2"},
47+
"react-dom": "^17.0.2"
48+
},
4649
"devDependencies": {
4750
"@babel/core": "^7.11.6",
4851
"@rollup/plugin-commonjs": "^20.0.0",
@@ -94,4 +97,4 @@
9497
"test": "jest",
9598
"test:coveralls": "jest --coverage && coveralls < coverage/lcov.info"
9699
}
97-
}
100+
}

0 commit comments

Comments
 (0)