UNPKG

1.69 kBMarkdownView Raw
1# @uppy/transloadit
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/transloadit"><img src="https://img.shields.io/npm/v/@uppy/transloadit.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
8The Transloadit plugin can be used to upload files to Transloadit for all kinds of processing, such as transcoding video, resizing images, zipping/unzipping, [and more](https://transloadit.com/services/).
9
10[Try it live →](https://uppy.io/examples/transloadit/)
11
12Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
13
14## Example
15
16```js
17const Uppy = require('@uppy/core')
18const Transloadit = require('@uppy/transloadit')
19
20const uppy = new Uppy()
21uppy.use(Transloadit, {
22 // Plugins
23})
24```
25
26## Installation
27
28```bash
29$ npm install @uppy/transloadit --save
30```
31
32We 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/).
33
34Alternatively, 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.
35
36## Documentation
37
38Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/transloadit).
39
40## License
41
42[The MIT License](./LICENSE).