Skip to content

Commit c604690

Browse files
committed
[REF]: Improve reademe file
1 parent 51a5549 commit c604690

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,22 @@
88
[![kandi X-Ray](https://kandi.openweaver.com/badges/xray.svg)](https://kandi.openweaver.com/typescript/dropzone-ui/dropzone-ui-react)
99
[![Node.js CI](https://github.com/dropzone-ui/react-dropzone/actions/workflows/node.js.yml/badge.svg)](https://github.com/dropzone-ui/dropzone-ui-react)
1010
[![Build Status](https://app.travis-ci.com/dropzone-ui/dropzone-ui-react.svg?branch=master)](https://app.travis-ci.com/dropzone-ui/dropzone-ui-react)
11-
[![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)
12-
[![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/)
1311
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/react/badge.svg)](https://snyk.io/test/github/dropzone-ui/react)
1412
[![Package Quality](https://packagequality.com/shield/dropzone-ui.svg)](https://packagequality.com/#?package=dropzone-ui)
1513
[![install size](https://packagephobia.com/badge?p=@dropzone-ui/react)](https://packagephobia.com/result?p=@dropzone-ui/react)
1614
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/dropzone-ui/react.svg)](http://isitmaintained.com/project/dropzone-ui/react)
1715
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1816
[![GitHub Repo stars](https://img.shields.io/github/stars/dropzone-ui/react?label=Star%20me%20please%20:D&style=social)](https://github.com/dropzone-ui/react)
1917

20-
<p align="center">
21-
22-
<img src="https://user-images.githubusercontent.com/43678736/148801752-954fa819-023d-4596-b557-56f7a38f4745.png" align="center" width="95%">
23-
</p>
2418

25-
Thanks for using dropzone-ui/react :heart: ! Dropzone UI has grown very fast and has exceeded its original scope. That's why we find reasonable to rebrand it and create a new package taking the best of this one and adding more features and new components. This new package is Files UI :zap:
2619

27-
:zap: Live demo and full documentation : [files-ui.com](https://files-ui.vercel.app)
20+
Thank you so much for using dropzone-ui/react ❤️ !
21+
Dropzone UI has grown very fast and has exceeded its original scope. That's why we find reasonable to rebrand it and create a new package taking the best of this one and adding more features and new components. This new package is here and its name is Files UI ⚡
22+
In an very near future we'll stop giving support to dropzone-ui, so we enforce you to upgrade to this new package. In the meanwhile this package will become a wrapper for files-ui.
2823

29-
:heart: it ?, support us by giving a :star: on :octocat: [Github](https://github.com/files-ui/react-files-ui) :D
24+
:zap: Live demos and full documentation : [files-ui.com](https://files-ui.vercel.app)
25+
26+
:heart: it ?, support us by giving a :star: on :octocat: [Github](https://github.com/files-ui/files-ui-react) :D
3027

3128
<p align="center">
3229
<a href="https://www.files-ui.com">
@@ -36,23 +33,19 @@ Thanks for using dropzone-ui/react :heart: ! Dropzone UI has grown very fast and
3633

3734
## Important
3835

39-
From now on [@files-ui/react]() is the only dependency.
36+
From now on [@files-ui/react](https://www.npmjs.com/package/@files-ui/react) is the only dependency. Check out the changelog file to know what's new.
4037

4138
## Sample result:
4239

43-
On `Drag`, `Drop`, `Upload` and full screen `preview`. (also changing view mode from `grid` to `list`).
44-
40+
This is a small part of what you can find on files-ui :eyes:
4541
<p align="center">
46-
<a href="https://github.com/dropzone-ui/react#readme">
47-
<img align="center" width="100%" src="https://user-images.githubusercontent.com/43678736/139614260-602b512c-cf78-48fe-ae57-1057e7ec8135.gif" alt="dropone-ui-preview">
42+
<a href="https://www.files-ui.com">
43+
<img src="https://user-images.githubusercontent.com/43678736/228052494-99d970c0-1eb7-42c6-b22c-8c2295b8dc4a.gif" width="80%" alt="fui-logo"/>
4844
</a>
49-
5045
</p>
5146

5247
- More previews [here](#more-previews).
5348

54-
- 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
55-
5649

5750
## Requirement
5851

@@ -72,6 +65,9 @@ npm i @dropzone-ui/react
7265
yarn add @dropzone-ui/react
7366
```
7467

68+
## API documentation
69+
The complete documentation of every component has been moved to files-ui.com [API page](https://www.files-ui.com/api/dropzone). However if you are still using dropzone-ui version 6 or less you can find the documentation [here](https://www.npmjs.com/package/@dropzone-ui/react/v/6.7.20#dropzone-ui-react-components-api).
70+
7571
## Supporters
7672

7773
Special thanks to these amazing people :star: :

0 commit comments

Comments
 (0)