mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-23 10:18:40 +00:00
2c29fa5f77
This can be copied to kickstart a new package: ```bash cp -R package-template packages/@uppy/dashboard vim packages/@uppy/dashboard/README.md # update PLUGINNAME and other all caps references vim packages/@uppy/dashboard/package.json # add a description and fix the `name` vim packages/@uppy/dashboard/src/index.js # implement! vim packages/@uppy/dashboard/types/index.d.ts # implement! ``` |
||
|---|---|---|
| .. | ||
| src | ||
| types | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
@uppy/PLUGINNAME
A description of this plugin or module goes here.
Uppy is being developed by the folks at Transloadit, a versatile file encoding service.
Example
const Uppy = require('@uppy/core')
const PLUGIN = require('@uppy/PLUGINNAME')
const uppy = Uppy()
uppy.use(PLUGIN, {
})
Installation
$ npm install @uppy/PLUGINNAME --save
We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.
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 for instructions.
Documentation
Documentation for this plugin can be found on the Uppy website.