Skip to content

Commit 7b12940

Browse files
committed
[REF]: Improve the readme file
1 parent f1a336b commit 7b12940

File tree

2 files changed

+34
-58
lines changed

2 files changed

+34
-58
lines changed

README.md

Lines changed: 33 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,49 @@
1-
# Files ui
2-
31
<p align="center">
4-
<img src="https://user-images.githubusercontent.com/43678736/202515913-dceafe68-d99b-42c0-b797-7057008928e0.png" width="150" height="150" alt="fui-logo"/></p>
5-
6-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
7-
8-
## Available Scripts
9-
10-
In the project directory, you can run:
11-
12-
### `npm start`
13-
14-
Runs the app in the development mode.\
15-
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
16-
17-
The page will reload when you make changes.\
18-
You may also see any lint errors in the console.
19-
20-
### `npm test`
21-
22-
Launches the test runner in the interactive watch mode.\
23-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
24-
25-
### `npm run build`
26-
27-
Builds the app for production to the `build` folder.\
28-
It correctly bundles React in production mode and optimizes the build for the best performance.
29-
30-
The build is minified and the filenames include the hashes.\
31-
Your app is ready to be deployed!
32-
33-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
34-
35-
### `npm run eject`
36-
37-
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
38-
39-
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
40-
41-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
42-
43-
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
2+
<img src="https://user-images.githubusercontent.com/43678736/226257748-6ba2f8cf-59c5-40d1-a545-a388ddab0f68.png" width="150" height="150" alt="fui-logo"/>
3+
</p>
4+
<h1 align="center">Files ui</h1>
445

45-
## Learn More
466

47-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
487

49-
To learn React, check out the [React documentation](https://reactjs.org/).
508

51-
### Code Splitting
529

53-
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
5410

55-
### Analyzing the Bundle Size
11+
<div align="center">
5612

57-
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
13+
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dropzone-ui/react/blob/HEAD/LICENSE)
14+
[![npm latest package](https://img.shields.io/npm/v/@dropzone-ui/react.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/@dropzone-ui/react)
15+
[![Rate on Openbase](https://badges.openbase.com/js/rating/@dropzone-ui/react.svg)](https://openbase.com/js/@dropzone-ui/react?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)
16+
[![kandi X-Ray](https://kandi.openweaver.com/badges/xray.svg)](https://kandi.openweaver.com/typescript/dropzone-ui/dropzone-ui-react)
17+
[![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)
18+
[![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)
5819

59-
### Making a Progressive Web App
20+
[![Known Vulnerabilities](https://snyk.io/test/github/dropzone-ui/react/badge.svg)](https://snyk.io/test/github/dropzone-ui/react)
21+
[![Package Quality](https://packagequality.com/shield/dropzone-ui.svg)](https://packagequality.com/#?package=dropzone-ui)
22+
[![install size](https://packagephobia.com/badge?p=@dropzone-ui/react)](https://packagephobia.com/result?p=@dropzone-ui/react)
23+
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/dropzone-ui/react.svg)](http://isitmaintained.com/project/dropzone-ui/react)
24+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
25+
[![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)
6026

61-
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
27+
</div>
28+
**Files UI** is a complete library for handling files in the UI. You can validate and upload them.
29+
<a href="https://github.com/dropzone-ui/react#readme">
30+
<img align="center" width="100%" src="https://user-images.githubusercontent.com/43678736/139614260-602b512c-cf78-48fe-ae57-1057e7ec8135.gif" alt="dropone-ui-preview">
31+
</a>
6232

63-
### Advanced Configuration
33+
## Requirement
6434

65-
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
35+
`@files-ui/react` is based on [React Hooks](https://reactjs.org/docs/hooks-intro.html). It requires `react v16.8+`.
6636

67-
### Deployment
37+
## Installation
6838

69-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
39+
@files-ui/react is available as an [npm package](https://www.npmjs.com/package/@files-ui/react).
7040

71-
### `npm run build` fails to minify
41+
```sh
42+
// with npm
43+
npm i @files-ui/react
44+
```
7245

73-
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
46+
```sh
47+
// with yarn
48+
yarn add @files-ui/react
49+
```

src/data/ValidateFileResponseAPIrows.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import CodeHighlight from "../components/codeHighlight/CodeHighlight";
1+
//import CodeHighlight from "../components/codeHighlight/CodeHighlight";
22
import TypeHighlight from "../components/typeHighlight/TypeHighlight";
33

44
export const ValidateFileResponseAPIrows = [

0 commit comments

Comments
 (0)