Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
evanminto committed Sep 26, 2018
1 parent 8bd8c0f commit a05523e
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# Uppy-Cloudinary
This is a plugin for uploading files to [Cloudinary](https://cloudinary.com/) via [Uppy](https://uppy.io/).
This is a plugin for uploading files to [Cloudinary](https://cloudinary.com/)
via [Uppy](https://uppy.io/).

## How to Use

Install via NPM:
```bash
npm install --save @CapsureIt/uppy-cloudinary
```

Use it in your project:
```javascript
// Import via ES Modules
import CloudinaryPlugin from '@CapsureIt/uppy-cloudinary';
// Or Common JS
const CloudinaryPlugin = require('@CapsureIt/uppy-cloudinary');

// Use it on your Uppy instance
uppy.use(CloudinaryPlugin, {
cloudName: 'my-cloud',
uploadPreset: 'my-preset',
apiKey: '1234567890',
generateSignature: function generateSignature(paramsToSign) {
// Include your own signature generation logic here.
},
tags: ['a', 'b', 'c'],
folder: 'prefix/for/publicId'
});
```

## Options
The plugin supports the following Cloudinary options:
Expand All @@ -21,6 +49,6 @@ docs](https://cloudinary.com/documentation/signatures) for instructions on how
to generate a signature

## Contributing
There are a lot of things I didn’t include, since this plugin was largely made
to help with a specific project. If you would like to improve this plugin and/or add
more features, please submit a pull request.
There are a lot of Cloudinary features we didn’t include, since this plugin was
largely made to serve our current needs. If you would like to improve this
plugin and/or add more features, please submit a pull request.

0 comments on commit a05523e

Please sign in to comment.