Skip to content

Commit d133fdd

Browse files
committed
Improve documentation of this repo.
1 parent 92c246b commit d133fdd

File tree

3 files changed

+24
-136
lines changed

3 files changed

+24
-136
lines changed

CONTRIBUTING.md

+3-41
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,7 @@
11
Contribute
22
==========
33

4-
> **I'm in the process of making some substantial changes to this library,
5-
> so please DO NOT create any PRs. I will simply close them.**
4+
This is a generated repo with generated files.
65

7-
8-
When I'm done, these rules will apply:
9-
10-
11-
Communicate
12-
-----------
13-
14-
Before you start implementing new features, please create an issue about it
15-
first and discuss your intent.
16-
17-
It might be something that someone else is already implementing or that goes
18-
against the concepts of Dropzone, and I really hate rejecting pull requests
19-
others spent hours writing on.
20-
21-
22-
Developer Dependencies
23-
----------------------
24-
25-
The first thing you need to do, is to install the developer dependencies:
26-
27-
```bash
28-
$ npm install
29-
```
30-
31-
This will install all the tools you need to compile the source files and to test
32-
the library.
33-
34-
35-
ECMAScript 6 & Sass (-> Javascript & CSS)
36-
------------------------------------------
37-
38-
Since June 2017, Dropzone is written in [ECMAScript
39-
6](https://babeljs.io/learn-es2015/) and [Sass](http://sass-lang.com/).
40-
41-
42-
Testing
43-
-------
44-
45-
To test the library simply run `npm run test`.
6+
Don't create PRs against this repo (unless they relate to fixing the automation
7+
process).

README.md

+4-79
Original file line numberDiff line numberDiff line change
@@ -4,87 +4,12 @@ Dropzone.js is a JavaScript library that turns any HTML element into a dropzone.
44
This means that a user can drag and drop a file onto it, and the file gets
55
uploaded to the server via XHR.
66

7-
The file either gets uploaded directly to the configured URL, or you can handle
8-
and manage the file upload yourself.
7+
# Packagist Repo
98

9+
This repo only exists to allow auto updating with the packagist package manager.
1010

11-
If you want support, please use the [discussions
12-
section](https://github.com/dropzone/dropzone/discussions) or
13-
[stackoverflow](https://stackoverflow.com/questions/tagged/dropzone.js) with the
14-
`dropzone.js` tag and **not** the GitHub issues tracker. Only post an issue here
15-
if you think you discovered a bug or have a feature request.
16-
17-
18-
* * *
19-
20-
> **Please read the [contributing guidelines](CONTRIBUTING.md) before you start
21-
> working on Dropzone!**
22-
23-
24-
<img alt="Dropzone Screenshot" width="585" src="http://i.imgur.com/Xf7QvVG.png" />
25-
26-
27-
Quickstart
28-
----------
29-
30-
The recommended way to install Dropzone is with [yarn](https://yarnpkg.com) and
31-
[webpack](http://webpack.js.org). I'll provide an example project soon!
32-
33-
[Download the standalone files](https://github.com/dropzone/dropzone/releases/latest/download/dist.zip) and import them on your website.
34-
(The JavaScript files in there are UMD modules, compatible with requirejs).
35-
36-
For more information, please consult the [Documentation](https://dropzone.gitbook.io/dropzone/).
37-
38-
Dropzone does **not** depend on jQuery but has jQuery integration.
39-
40-
Main features
41-
-------------
42-
43-
- Beautiful by default
44-
- Image thumbnail previews. Simply register the callback `thumbnail(file, data)`
45-
and display the image wherever you like
46-
- Retina enabled
47-
- Multiple files and synchronous uploads
48-
- Progress updates
49-
- Support for large files
50-
- Complete theming. The look and feel of Dropzone is just the default theme. You
51-
can define everything yourself by overwriting the default event listeners.
52-
- Browser image resizing (resize the images before you upload them to your
53-
server)
54-
- Well tested
55-
56-
Documentation
57-
-------------
58-
59-
For all the configuration options and installation guide please visit [the documentation site](https://dropzone.gitbook.io/dropzone/)
60-
61-
## Examples
62-
63-
For examples, please see the [GitLab wiki](https://github.com/dropzone/dropzone/wiki).
64-
65-
66-
Server side implementation
67-
--------------------------
68-
69-
Dropzone does *not* provide the server side implementation of handling the
70-
files, but the way files are uploaded is identical to simple file upload forms
71-
like this:
72-
73-
```html
74-
<form action="" method="post" enctype="multipart/form-data">
75-
<input type="file" name="file" />
76-
</form>
77-
```
78-
79-
To handle basic file uploads on the server, please look at the corresponding
80-
documentation. Here are a few documentations, if you think I should add some,
81-
please contact me.
82-
83-
# Compatibility
84-
85-
Dropzone supports all current browsers and IE up to IE11.
86-
87-
For all the other browsers, dropzone provides an oldschool file input fallback.
11+
The original repo with the actual source code of Dropzone is here:
12+
https://github.com/dropzone/dropzone
8813

8914
# MIT License
9015

composer.json

+17-16
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
{
2-
"name": "enyo/dropzone",
3-
"description": "Handles drag and drop of files for you.",
4-
"homepage": "http://www.dropzonejs.com",
5-
"keywords": [
6-
"dragndrop",
7-
"drag and drop",
8-
"file upload",
9-
"upload"
10-
],
11-
"authors": [{
12-
"name": "Matias Meno",
13-
"email": "[email protected]",
14-
"homepage": "http://www.matiasmeno.com"
15-
}],
16-
"license": "MIT",
17-
"minimum-stability": "dev"
2+
"name": "enyo/dropzone",
3+
"description": "Handles drag and drop of files for you.",
4+
"homepage": "http://www.dropzonejs.com",
5+
"keywords": [
6+
"dragndrop",
7+
"drag and drop",
8+
"file upload",
9+
"upload"
10+
],
11+
"authors": [
12+
{
13+
"name": "Matias Meno",
14+
"email": "[email protected]",
15+
"homepage": "http://www.yesmeno.com"
16+
}
17+
],
18+
"license": "MIT"
1819
}

0 commit comments

Comments
 (0)