From e816aee49a15b9680f9c1b0bdc72d482913b1dfc Mon Sep 17 00:00:00 2001 From: Nicolas CARPi Date: Fri, 12 Apr 2024 15:00:13 +0200 Subject: [PATCH] refresh readme --- CHANGELOG.md | 9 +++++++++ README.md | 38 ++++++++++++-------------------------- 2 files changed, 21 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0220741d0..d7c370d1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/README.md b/README.md index b4752c11c..efb3b989a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ Dropzone.js -[![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 @@ -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.
@@ -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): @@ -53,10 +53,10 @@ bundlers](https://github.com/dropzone/dropzone-examples) Use the standalone files like this: ```html - + @@ -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 ✅ @@ -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