| 1 | # @uppy/core
|
| 2 |
|
| 3 | <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">
|
| 4 |
|
| 5 | <a href="https://www.npmjs.com/package/@uppy/core"><img src="https://img.shields.io/npm/v/@uppy/core.svg?style=flat-square"></a>
|
| 6 | <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>
|
| 7 |
|
| 8 | Uppy is a sleek, modular JavaScript 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.
|
| 9 |
|
| 10 | - **Fetch** files from local disk, remote urls, Google Drive, Dropbox, Instagram, or snap and record selfies with a camera;
|
| 11 | - **Preview** and edit metadata with a nice interface;
|
| 12 | - **Upload** to the final destination, optionally process/encode
|
| 13 |
|
| 14 | **[Read the docs](https://uppy.io/docs)** | **[Try Uppy](https://uppy.io/examples/dashboard/)**
|
| 15 |
|
| 16 | Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
|
| 17 |
|
| 18 | ## Example
|
| 19 |
|
| 20 | ```js
|
| 21 | const Uppy = require('@uppy/core')
|
| 22 |
|
| 23 | const uppy = new Uppy()
|
| 24 | uppy.use(SomePlugin)
|
| 25 | ```
|
| 26 |
|
| 27 | ## Installation
|
| 28 |
|
| 29 | ```bash
|
| 30 | $ npm install @uppy/core
|
| 31 | ```
|
| 32 |
|
| 33 | We recommend installing from npm and then using a module bundler such as [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/).
|
| 34 |
|
| 35 | Alternatively, you can also use this plugin in a pre-built bundle from Transloadit's CDN: Edgly. In that case `Uppy` will attach itself to the global `window.Uppy` object. See the [main Uppy documentation](https://uppy.io/docs/#Installation) for instructions.
|
| 36 |
|
| 37 | ## Documentation
|
| 38 |
|
| 39 | Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/uppy).
|
| 40 |
|
| 41 | ## License
|
| 42 |
|
| 43 | [The MIT License](./LICENSE).
|