1 | # @uppy/golden-retriever
|
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/golden-retriever"><img src="https://img.shields.io/npm/v/@uppy/golden-retriever.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 | The GoldenRetriever plugin saves selected files in your browser cache (Local Storage for metadata, then Service Worker for all blobs + IndexedDB for small blobs), so that if the browser crashes, Uppy can restore everything and continue uploading like nothing happened. Read more about it [on the blog](https://uppy.io/blog/2017/07/golden-retriever/).
|
9 |
|
10 | Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
|
11 |
|
12 | ## Example
|
13 |
|
14 | ```js
|
15 | const Uppy = require('@uppy/core')
|
16 | const GoldenRetriever = require('@uppy/golden-retriever')
|
17 |
|
18 | const uppy = Uppy()
|
19 | uppy.use(GoldenRetriever, {
|
20 | // Options
|
21 | })
|
22 | ```
|
23 |
|
24 | ## Installation
|
25 |
|
26 | ```bash
|
27 | $ npm install @uppy/golden-retriever --save
|
28 | ```
|
29 |
|
30 | 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/).
|
31 |
|
32 | 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.
|
33 |
|
34 | ## Documentation
|
35 |
|
36 | Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/golden-retriever).
|
37 |
|
38 | ## License
|
39 |
|
40 | [The MIT License](./LICENSE).
|