Skip to content

Commit 261903a

Browse files
authored
Merge pull request #13 from colbyfayock/netlify-ui
Netlify UI README
2 parents 07bdbfe + d3ddcf1 commit 261903a

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,27 @@ tl;dr automatically serve smaller images in modern formats
1717

1818
## ⚡️ Getting Started
1919

20-
- Sign up for a free [Cloudinary](https://cloudinary.com/) account.
20+
Before installing, make sure you're set up with a free [Cloudinary](https://cloudinary.com/) account.
2121

22-
- Install the plugin:
22+
### Installing via Netlify UI
2323

24-
```shell
25-
npm install netlify-plugin-cloudinary
26-
# or
27-
yarn add netlify-plugin-cloudinary
24+
- [Install the plugin](https://app.netlify.com/plugins/netlify-plugin-cloudinary/install) using the [Netlify Build Plugins Directory](https://app.netlify.com/plugins)
25+
26+
<https://app.netlify.com/plugins/netlify-plugin-cloudinary/install>
27+
28+
- Add your Cloudinary Cloud Name as a [build environment variable](https://docs.netlify.com/configure-builds/environment-variables)
29+
30+
```
31+
Name: CLOUDINARY_CLOUD_NAME
32+
Value: <Your Cloud Name>
2833
```
2934

35+
- Trigger a new deploy!
36+
37+
By default, your images will served via the [fetch delivery type](https://cloudinary.com/documentation/fetch_remote_images).
38+
39+
### File-based configuration
40+
3041
- Add the plugin to your Netlify config:
3142

3243
```toml
@@ -46,6 +57,18 @@ yarn add netlify-plugin-cloudinary
4657

4758
By default, your images will served via the [fetch delivery type](https://cloudinary.com/documentation/fetch_remote_images).
4859

60+
### Installing locally
61+
62+
- Install the plugin:
63+
64+
```shell
65+
npm install netlify-plugin-cloudinary
66+
# or
67+
yarn add netlify-plugin-cloudinary
68+
```
69+
70+
- Use a [file-based configuration](#file-based-configuration) to add the plugin to your builds
71+
4972
## 🛠 Configuration
5073

5174
### Plugin Inputs

0 commit comments

Comments
 (0)