|
@@ -1,33 +1,34 @@
|
|
|
-# Uppy
|
|
|
+# [Uppy](http://uppy.io)
|
|
|
|
|
|
-<img src="http://uppy.io/images/logos/uppy-dog-full.svg" width="120" alt="Uppy logo — a superman puppy in a pink suit" align="right">
|
|
|
+<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">
|
|
|
|
|
|
-<a href="https://www.npmjs.com/package/uppy"><img src="https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square"></a>
|
|
|
<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 framework. It fetches files from local disk, Google Drive, Dropbox, Instagram, remote URLs, cameras and other exciting locations, and then uploads them to the final destination. It’s fast, easy to use and let's you worry about more important problems than building a file uploader. [Try it live](http://uppy.io/examples/dashboard/).
|
|
|
+Uppy is a sleek, modular file uploader that integrates seemlessly with any application.
|
|
|
|
|
|
-Uppy is developed by the [Transloadit](https://transloadit.com) team.
|
|
|
+- **Fetch** files from local disk, Google Drive, Dropbox, Instagram. Take selfies and videos with a camera;
|
|
|
+- **Upload** files to the final destination, optionally processing/encoding on the way;
|
|
|
+- **Fast and easy to use**. Lets you worry about more important problems than building a file uploader.
|
|
|
|
|
|
-Check out docs and examples on [uppy.io](http://uppy.io).
|
|
|
+**[Try Uppy](http://uppy.io/examples/dashboard/)** | **[Read the docs](http://uppy.io/docs)**
|
|
|
|
|
|
-<img width="700" alt="Uppy UI Demo: modal dialog with a few selected files and an upload button" src="https://github.com/transloadit/uppy/raw/master/uppy-screenshot.jpg">
|
|
|
+*Uppy is being developed by the [Transloadit](https://transloadit.com) team.*
|
|
|
|
|
|
-- [Full featured UI](http://uppy.io/examples/dashboard)
|
|
|
-- [Simple Drag & Drop](http://uppy.io/examples/dragdrop)
|
|
|
+<img width="700" alt="Uppy UI Demo: modal dialog with a few selected files and an upload button" src="https://github.com/transloadit/uppy/raw/master/uppy-screenshot.jpg">
|
|
|
|
|
|
## Features
|
|
|
|
|
|
- Lightweight, modular plugin-based architecture, easy on dependencies :zap:
|
|
|
-- Use from a CDN or as a module to import
|
|
|
- Resumable file uploads via the open [tus](http://tus.io/) standard
|
|
|
- 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)
|
|
|
-- A sleek user interface :sparkles:
|
|
|
+- 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)
|
|
|
+- Sleek user interface :sparkles:
|
|
|
+- Optional file recovering (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 🗽)
|
|
|
-- 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)
|
|
|
- Cute as a puppy, also accepts cat pictures :dog:
|
|
|
|
|
|
## Installation
|
|
@@ -73,6 +74,22 @@ If you like, you can also use a pre-built bundle, for example from [unpkg CDN](h
|
|
|
- [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.
|
|
|
- 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
|
|
|
+- `Dashboard` — universal UI with previews, progress bars and the cool stuff
|
|
|
+- `DragDrop` — plain and simple drag and drop area
|
|
|
+- `FileInput` — even more plain “select files” button
|
|
|
+- `ProgressBar` — plain progress bar that fills itself when upload progresses
|
|
|
+- `StatusBar` — more detailed progress, pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (included by default with `Dashboard`)
|
|
|
+- `Informer` — send notifications: “smile” before taking a selfie, “upload failed” when all is lost (also included by default with `Dashboard`)
|
|
|
+- `RestoreFiles` — restores files after a browser crash, like it’s nothing
|
|
|
+- `GoogleDrive` — select files from [Google Drive](https://www.google.com/drive/)
|
|
|
+- `Dropbox` — select files from [Dropbox](https://www.dropbox.com/)
|
|
|
+- `Instagram` — you guessed right — select files from [Instagram](https://www.instagram.com/)
|
|
|
+- `Webcam` — snap and record those selfies 📷
|
|
|
+
|
|
|
## Browser Support
|
|
|
|
|
|
<a href="https://saucelabs.com/u/transloadit-uppy">
|