|
|
@@ -1,18 +1,17 @@
|
|
|
-# [Uppy](http://uppy.io)
|
|
|
+# [Uppy](https://uppy.io)
|
|
|
|
|
|
-<img src="http://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
|
|
|
+<img src="https://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
|
|
|
|
|
|
<a href="https://www.npmjs.com/package/uppy"><img src="https://img.shields.io/npm/v/uppy.svg?style=flat-square"></a>
|
|
|
<a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
|
|
|
-<a href="https://www.npmjs.com/package/uppy"><img src="https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square"></a>
|
|
|
|
|
|
-Uppy is a sleek, modular file uploader that integrates seemlessly with any application. It’s fast, easy to use and lets you worry about more important problems than building a file uploader.
|
|
|
+Uppy is a sleek, modular file uploader that integrates seamlessly with any application. It’s fast, easy to use and lets you worry about more important problems than building a file uploader.
|
|
|
|
|
|
- **Fetch** files from local disk, Google Drive, Dropbox, Instagram, or snap and record selfies with a camera;
|
|
|
- **Preview** and edit metadata with a nice interface;
|
|
|
-- **Upload** to the final destination, optionally processing/encoding on the way;
|
|
|
+- **Upload** to the final destination, optionally process/encode
|
|
|
|
|
|
-**[Read the docs](http://uppy.io/docs)** | **[Try Uppy](http://uppy.io/examples/dashboard/)**
|
|
|
+**[Read the docs](https://uppy.io/docs)** | **[Try Uppy](https://uppy.io/examples/dashboard/)**
|
|
|
|
|
|
Uppy is being developed by the [Transloadit](https://transloadit.com) team.
|
|
|
|
|
|
@@ -42,16 +41,16 @@ const uppy = Uppy({ autoProceed: false })
|
|
|
})
|
|
|
```
|
|
|
|
|
|
-**[Try it online](http://uppy.io/examples/dashboard/)** or **[read the docs](http://uppy.io/docs)** for more details on how to use Uppy and its plugins.
|
|
|
+**[Try it online](https://uppy.io/examples/dashboard/)** or **[read the docs](https://uppy.io/docs)** for more details on how to use Uppy and its plugins.
|
|
|
|
|
|
## Features
|
|
|
|
|
|
- Lightweight, modular plugin-based architecture, easy on dependencies :zap:
|
|
|
-- Resumable file uploads via the open [tus](http://tus.io/) standard
|
|
|
+- Resumable file uploads via the open [tus](https://tus.io/) standard, so large uploads survive network hiccups
|
|
|
- Supports picking files from: Webcam, Dropbox, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via [uppy-server](https://github.com/transloadit/uppy-server)
|
|
|
-- Works great with file encoding and processing backends, such as [Transloadit](http://transloadit.com), works great without (just roll your own Apache/Nginx/Node/etc backend)
|
|
|
+- Works great with file encoding and processing backends, such as [Transloadit](https://transloadit.com), works great without (just roll your own Apache/Nginx/Node/FFmpeg/etc backend)
|
|
|
- Sleek user interface :sparkles:
|
|
|
-- Optional file recovering (after a browser crash) with [Golden Retriever](https://uppy.io/docs/golden-retriever/)
|
|
|
+- Optional file recovery (after a browser crash) with [Golden Retriever](https://uppy.io/docs/golden-retriever/)
|
|
|
- Speaks multiple languages (i18n) :earth_africa:
|
|
|
- Built with accessibility in mind
|
|
|
- Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
|
|
|
@@ -63,11 +62,11 @@ const uppy = Uppy({ autoProceed: false })
|
|
|
$ npm install uppy --save
|
|
|
```
|
|
|
|
|
|
-We recommend installing from NPM and then using a module bundler such as [Webpack](http://webpack.github.io/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/).
|
|
|
+We recommend installing from npm and then using a module bundler such as [Webpack](http://webpack.github.io/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/).
|
|
|
|
|
|
Add CSS [uppy.min.css](https://unpkg.com/uppy/dist/uppy.min.css), either to `<head>` of your HTML page or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack.
|
|
|
|
|
|
-If you like, you can also use a pre-built bundle, for example from [unpkg CDN](https://unpkg.com/uppy/). In that case `Uppy` will attach itself to the global `window.Uppy` object.
|
|
|
+Alternatively, you can also use a pre-built bundle, for example from [unpkg CDN](https://unpkg.com/uppy/). In that case `Uppy` will attach itself to the global `window.Uppy` object.
|
|
|
|
|
|
> ⚠️ The bundle currently consists of most Uppy plugins, so this method is not recommended for production, as your users will have to download all plugins, when you are likely using just a few.
|
|
|
|
|
|
@@ -85,6 +84,7 @@ If you like, you can also use a pre-built bundle, for example from [unpkg CDN](h
|
|
|
3\. Initialize:
|
|
|
|
|
|
``` html
|
|
|
+<div class="UppyDragDrop"></div>
|
|
|
<script>
|
|
|
var uppy = Uppy.Core()
|
|
|
uppy.use(Uppy.DragDrop, { target: '.UppyDragDrop' })
|
|
|
@@ -95,17 +95,17 @@ If you like, you can also use a pre-built bundle, for example from [unpkg CDN](h
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
-- [Uppy](http://uppy.io/docs/uppy/) — full list of options, methods and events.
|
|
|
-- [Plugins](http://uppy.io/docs/plugins/) — list of Uppy plugins and their options.
|
|
|
-- [Server](http://uppy.io/docs/server/) — setting up and running an Uppy Server instance, which adds support for Instagram, Dropbox, Google Drive and other remote sources.
|
|
|
-- [React](/docs/react/) — components to integrate uppy UI plugins with react apps.
|
|
|
+- [Uppy](https://uppy.io/docs/uppy/) — full list of options, methods and events.
|
|
|
+- [Plugins](https://uppy.io/docs/plugins/) — list of Uppy plugins and their options.
|
|
|
+- [Server](https://uppy.io/docs/server/) — setting up and running an Uppy Server instance, which adds support for Instagram, Dropbox, Google Drive and other remote sources.
|
|
|
+- [React](https://uppy.io/docs/react/) — components to integrate Uppy UI plugins with React apps.
|
|
|
- Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress].
|
|
|
|
|
|
## Plugins
|
|
|
|
|
|
-- `Tus` — resumable uploads via [tus.io](http://tus.io) open standard
|
|
|
-- `XHRUpload` — regular uploads for any backend out there
|
|
|
-- `Transloadit` — support for [Transloadit](http://transloadit.com)’s robust file encoding and processing backend
|
|
|
+- `Tus` — resumable uploads via the open [tus](http://tus.io) standard
|
|
|
+- `XHRUpload` — regular uploads for any backend out there (like Apache, Nginx)
|
|
|
+- `Transloadit` — support for [Transloadit](http://transloadit.com)’s robust file uploading and encoding backend
|
|
|
- `Dashboard` — universal UI with previews, progress bars, metadata editor and all the cool stuff
|
|
|
- `DragDrop` — plain and simple drag and drop area
|
|
|
- `FileInput` — even more plain “select files” button
|
|
|
@@ -113,7 +113,7 @@ If you like, you can also use a pre-built bundle, for example from [unpkg CDN](h
|
|
|
- `StatusBar` — more detailed progress, pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (included by default with `Dashboard`)
|
|
|
- `Informer` — send notifications like “smile” before taking a selfie or “upload failed” when all is lost (also included by default with `Dashboard`)
|
|
|
- `GoldenRetriever` — restores files after a browser crash, like it’s nothing
|
|
|
-- `Form` — collects metadata from `<form>` right before Uppy upload, then optionally appends results back to the form
|
|
|
+- `Form` — collects metadata from `<form>` right before an Uppy upload, then optionally appends results back to the form
|
|
|
- `ReduxDevTools` — for your emerging [time traveling](https://github.com/gaearon/redux-devtools) needs
|
|
|
- `GoogleDrive` — select files from [Google Drive](https://www.google.com/drive/)
|
|
|
- `Dropbox` — select files from [Dropbox](https://www.dropbox.com/)
|
|
|
@@ -136,16 +136,20 @@ Yep, we have Uppy React components, please see [Uppy React docs](https://uppy.io
|
|
|
|
|
|
### Can I use it with Rails/Node/Go/PHP?
|
|
|
|
|
|
-Yes, whatever you want on the backend will work with `XHRUpload` plugin, since it just does a `POST` or `PUT` request. If you want resumability with the Tus plugin, use [one of tus server implementations](http://tus.io/implementations.html) 👌🏼
|
|
|
+Yes, whatever you want on the backend will work with `XHRUpload` plugin, since it just does a `POST` or `PUT` request. If you want resumability with the Tus plugin, use [one of the tus server implementations](https://tus.io/implementations.html) 👌🏼
|
|
|
|
|
|
### Do I need to install special service/server for it?
|
|
|
|
|
|
-No, as mentioned previously, `XHRUpload` plugin is old-school and just works with everything. However, you need [`uppy-server`](https://github.com/transloadit/uppy-server) if you’d like your users to be able to pick files from Google Drive or Dropbox (more services coming). And you can add [tus](http://tus.io) if you want resumability.
|
|
|
+Nope, as mentioned previously, the `XHRUpload` plugin is old-school and just works with everything. However, you need [`uppy-server`](https://github.com/transloadit/uppy-server) if you’d like your users to be able to pick files from Instagram, Google Drive or Dropbox (more services coming). And you can add [tus](http://tus.io) if you want resumability.
|
|
|
|
|
|
### Does Uppy support S3 uploads?
|
|
|
|
|
|
Yes, there is an S3 plugin, check out the [docs](https://uppy.io/docs/aws-s3/) for more!
|
|
|
|
|
|
+### Why is all this goodness free?
|
|
|
+
|
|
|
+Transloadit's team is small and we have a shared ambition to make a living from open source. By giving away projects like [tus.io](https://tus.io) and [Uppy](https://uppy.io), we're hoping to advance the state of the art, make life a tiny little bit better for everyone, and in doing so have rewarding jobs and get some eyes on our commercial service: [a content ingestion & processing platform](https://transloadit.com). Our thinking is that if just a fraction of our open source userbase can see the appeal of hosted versions straight from the source, that could already be enough to sustain our work. So far this is working out! We're able to dedicate 80% of our time to open source and haven't gone bankrupt just yet :D
|
|
|
+
|
|
|
## Contributions are welcome
|
|
|
|
|
|
- Contributor’s guide in [`website/src/docs/contributing.md`](website/src/docs/contributing.md)
|
Artur Paikin