Skip to content

Commit

Permalink
refresh readme
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasCARPi committed Apr 12, 2024
1 parent 704de01 commit e816aee
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 26 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## 7.0.3

* Add more files to .npmignore: no need to distribute parcel-cache or documentation files
* Remove composer.json

## 7.0.2

* Try and fix the publish on npm action (it worked).

## 7.0.1

* Upgrade publish action version. Try and fix the publish on npm action.
Expand Down
38 changes: 12 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<img alt="Dropzone.js" src="https://raw.githubusercontent.com/dropzone/dropzone/assets/github-logo.svg" />

[![Validate](https://github.com/NicolasCARPi/dropzone/actions/workflows/validating.yml/badge.svg)](https://github.com/dropzone/dropzone/actions/workflows/validating.yml)
[![CodeQL](https://github.com/NicolasCARPi/dropzone/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/dropzone/dropzone/actions/workflows/codeql-analysis.yml)
[![Validate](https://github.com/NicolasCARPi/dropzone/actions/workflows/validating.yml/badge.svg)](https://github.com/NicolasCARPi/dropzone/actions/workflows/validating.yml)
[![CodeQL](https://github.com/NicolasCARPi/dropzone/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/NicolasCARPi/dropzone/actions/workflows/codeql-analysis.yml)

# Fork

This fork exists because upstream isn't maintained anymore.
This fork exists because upstream isn't maintained anymore. Its goal is to maintain this library in a good state, with mainly bugfixes and possibly minor improvements.

# Description

Expand All @@ -14,7 +14,7 @@ This means that a user can drag and drop a file onto it, and Dropzone will
display file previews and upload progress, and handle the upload for you via
XHR.

It's fully configurable, can be styled according to your needs and is trusted by
It is fully configurable, can be styled according to your needs and is trusted by
thousands.

<div align="center">
Expand All @@ -26,9 +26,9 @@ thousands.
Install:

```bash
$ npm install --save dropzone
$ npm install --save @deltablot/dropzone
# or with yarn:
$ yarn add dropzone
$ yarn add @deltablot/dropzone
```

Use as **ES6 module** (recommended):
Expand All @@ -53,10 +53,10 @@ bundlers](https://github.com/dropzone/dropzone-examples)
Use the standalone files like this:

```html
<script src="https://unpkg.com/dropzone@5/dist/min/dropzone.min.js"></script>
<script src="https://unpkg.com/@deltablot/dropzone@7/dist/dropzone.min.js"></script>
<link
rel="stylesheet"
href="https://unpkg.com/dropzone@5/dist/min/dropzone.min.css"
href="https://unpkg.com/@deltablot/dropzone@7/dist/dropzone.min.css"
type="text/css"
/>

Expand All @@ -71,31 +71,17 @@ Use the standalone files like this:
---

- [📚 Full documentation](https://docs.dropzone.dev)
- [⚙️ `src/options.js`](https://github.com/dropzone/dropzone/blob/main/src/options.js)
- [⚙️ `src/options.js`](https://github.com/NicolasCARPi/dropzone/blob/main/src/options.js)
for all available options

---

> ⚠️ **NOTE**: We are currently moving away from IE support to make the library
> more lightweight. If you don't care about IE but about size, you can already
> opt into `6.0.0-beta.1`. Please make sure to pin the specific version since
> parts of the API might change slightly. You can always read about the changes
> in the [`CHANGELOG`](./CHANGELOG.md) file.
## Community

If you need support please use the [discussions section][discussions] or
[stackoverflow][so] with the `dropzone.js` tag and **not** the GitHub issues
tracker. Only post an issue here if you think you discovered a bug.
If you need support please open an [issue](https://github.com/NicolasCARPi/dropzone/issues).

If you have a feature request or want to discuss something, please use the
[discussions][] as well.

[discussions]: https://github.com/dropzone/dropzone/discussions
[so]: https://stackoverflow.com/questions/tagged/dropzone.js

> ⚠️ **Please read the [contributing guidelines](CONTRIBUTING.md) before you
> start working on Dropzone!**
[issues](https://github.com/NicolasCARPi/dropzone/issues) as well.

## Main features ✅

Expand All @@ -116,4 +102,4 @@ If you have a feature request or want to discuss something, please use the

# MIT License

See the [LICENSE](https://github.com/dropzone/dropzone/blob/main/LICENSE) file
See the [LICENSE](./LICENSE) file

0 comments on commit e816aee

Please sign in to comment.