Skip to content

Commit 14e982f

Browse files
committed
[REF]: Improve readme and update next version
1 parent b103d29 commit 14e982f

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

Diff for: README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<h1 align="center">Files ui</h1>
88

99
UI components for file uploads with [React js](https://react.dev/).
10+
1011
**Files UI** is a complete library for handling files in the UI. You can validate and upload them.
1112

1213
<div align="center">
@@ -15,9 +16,7 @@ UI components for file uploads with [React js](https://react.dev/).
1516
[![npm latest package](https://img.shields.io/npm/v/@files-ui/react.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/@files-ui/react) [![kandi X-Ray](https://kandi.openweaver.com/badges/xray.svg)](https://kandi.openweaver.com/typescript/files-ui/files-ui-react) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
1617
[![GitHub Repo stars](https://img.shields.io/github/stars/files-ui/react?label=Star%20me%20please%20:D&style=social)](https://github.com/files-ui/react)
1718

18-
[![Verified on Openbase](https://badges.openbase.com/js/verified/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) [![Featured on Openbase](https://badges.openbase.com/js/featured/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) [![Rate this package](https://badges.openbase.com/js/rating/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) [![@files-ui/react Tutorials](https://badges.openbase.com/js/tutorials/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge)
19-
20-
19+
[![Verified on Openbase](https://badges.openbase.com/js/verified/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge) [![Featured on Openbase](https://badges.openbase.com/js/featured/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge) [![Rate this package](https://badges.openbase.com/js/rating/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge) [![@files-ui/react Tutorials](https://badges.openbase.com/js/tutorials/@files-ui/react.svg?style=openbase&token=KU5M2S80RznhcbmWDtZx1m9n8DBAO49K6UOwwvd4KVs=)](https://openbase.com/js/@files-ui/react?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)
2120

2221
</div>
2322

@@ -28,7 +27,6 @@ UI components for file uploads with [React js](https://react.dev/).
2827
</p>
2928

3029
- :heart: it ?, support us by giving a :star: on :octocat: [Github](https://github.com/dropzone-ui/dropzone-ui) :D
31-
3230

3331
- :zap: Enjoying @files-ui/react? [Please leave a short review on Openbase](https://openbase.com/js/@files-ui/react#rate)
3432
- :eyes: More previews [here](#more-previews).
@@ -55,7 +53,8 @@ Here is a quick example to get you started, **it's all you need**:
5553
import * as React from "react";
5654
import ReactDOM from "react-dom";
5755
import { Dropzone, FileMosaic } from "@files-ui/react";
58-
Function App() {
56+
57+
function App() {
5958
const [files, setFiles] = React.useState([]);
6059
const updateFiles = (incommingFiles) => {
6160
setFiles(incommingFiles);
@@ -74,22 +73,25 @@ ReactDOM.render(<App />, document.querySelector("#app"));
7473

7574
Yes, it's really all you need to get started as you can see in these live and interactive demos:
7675

77-
- [Basic sample](https://www.files-ui.com/usage#quick-start) :cake:
78-
- [Advanced sample](https://www.files-ui.com/usage#advanced-example) :hammer:
76+
| | |
77+
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
78+
| Basic Sample :cake: | [![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/basic-demo-js-blssi1?file=/src/App.js) |
79+
| Advanced Sample :hammer: | [![Edit Button](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/advanced-demo-js-6euo8j?file=/src/App.js) |
80+
81+
## Main Components 💠
7982

80-
## Main Components
8183
- [\<Dropzone/\>](https://www.files-ui.com/components/dropzone)
8284
- [\<FileMosaic/\>](https://www.files-ui.com/components/filemosaic)
8385
- [\<FileCard/\>](https://www.files-ui.com/components/filecard)
8486
- [\<Avatar/\>](https://www.files-ui.com/components/avatar)
8587
- [\<FIleInputButton/\>](https://www.files-ui.com/components/fileinputbutton)
8688
- [\<FullScreen/\>](https://www.files-ui.com/components/fullscreen) Image and video
8789

88-
## Full Documentation
90+
## Full Documentation 📚
8991

9092
You can find the complete documentation and demos for every component on [files-ui.com](https://www.files-ui.com)
9193

92-
## More Previews
94+
## More Previews :eyes:
9395

9496
<details>
9597
<summary>Image full screen preview 🖼️ </summary>

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@files-ui/react",
3-
"version": "1.0.5",
3+
"version": "1.0.8",
44
"description": "UI components for file uploads with React js",
55
"main": "./build/index.js",
66
"module": "./build/index.es.js",

0 commit comments

Comments
 (0)