Skip to content

Commit 2d1d339

Browse files
committed
[REF]: improve Readme
1 parent df18d59 commit 2d1d339

1 file changed

Lines changed: 19 additions & 9 deletions

File tree

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,49 @@
1010
[![npm latest package](https://img.shields.io/badge/npm%40LTS-1.0.5-magenta)](https://www.npmjs.com/package/dropzone-ui)
1111
[![dependencies Status](https://status.david-dm.org/gh/dropzone-ui/dropzone-ui.svg)](https://david-dm.org/dropzone-ui/dropzone-ui)
1212
[![Build Status](https://www.travis-ci.com/dropzone-ui/dropzone-ui.svg?branch=master)](https://www.travis-ci.com/dropzone-ui/dropzone-ui)
13-
[![install size](https://packagephobia.com/badge?p=dropzone-ui)](https://packagephobia.com/result?p=@unlimited-react-components/material-button)
13+
[![install size](https://packagephobia.com/badge?p=dropzone-ui)](https://packagephobia.com/result?p=dropzone-ui)
1414
[![Coverage Status](https://coveralls.io/repos/github/dropzone-ui/dropzone-ui/badge.svg?branch=master)](https://coveralls.io/github/unlimited-react-components/material-button?branch=master)
1515
[![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/)
1616
[![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)
17-
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/dropzone-ui/badge.svg)](https://snyk.io/test/github/unlimited-react-components/material-button)
17+
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/dropzone-ui/badge.svg)](https://snyk.io/test/github/dropzone-ui/dropzone-ui)
1818
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1919

2020
## Description
2121

22-
Dropzone components for mamanging file uploads. Components were made folllowing some of google's Material design principles.
22+
React components for mamanging file uploads. Components were made folllowing some of google's Material design principles.
2323

24-
Sample result:
24+
## Sample result:
25+
list view<p align="center">
2526

27+
<img align="center" width="900" src="https://user-images.githubusercontent.com/43678736/132430385-587cb866-09bf-4366-ae39-fdfdf9f69b92.png" alt="dropone-ui-logo">
28+
29+
30+
</p>grid view
2631
<p align="center">
27-
<!-- <img align="center" width="65%" src="https://user-images.githubusercontent.com/43678736/119084603-b74f7380-b9c7-11eb-8ea3-752cf72098e5.png" alt="dropzone-uisamle-screenshot"> -->
32+
33+
<img align="center" width="400px" src="https://user-images.githubusercontent.com/43678736/132430386-d71de2b8-36be-4b2a-838e-57ca0a7fa068.png" alt="dropone-ui-logo">
34+
35+
2836
</p>
2937

38+
39+
3040
## Installation
3141

32-
react-highlight is available as an [npm package](https://www.npmjs.com/package/@unlimited-react-components/react-highlight).
42+
dropzone-ui is available as an [npm package](https://www.npmjs.com/package/dropzone-ui).
3343

3444
```sh
3545
// with npm
36-
npm i @unlimited-react-components/react-highlight
46+
npm i dropzone-ui
3747
```
3848

3949
## Usage and examples
4050

4151
Here is a quick example to get you started, **it's all you need**:
4252

43-
[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/react-highlight-demo-7o9pq)
53+
[![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/basic-3j01v?file=/src/App.js)
4454

45-
# DropZone Components API
55+
# Dropzone UI Components API
4656

4757
- [\<DropzoneUI />](#dropzoneui-api)
4858
- [\<DropzoneLabel />](#dropzonelabel-api)

0 commit comments

Comments
 (0)