Skip to content

Commit f824fba

Browse files
authored
Update README.md
1 parent 044bd2a commit f824fba

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Optimize and serve all images served in your Netlify site deploy with [Cloudinar
66

77
- [Getting Started](#%EF%B8%8F-getting-started)
88
- [Configuration](#-configuration)
9-
- [How it Works](#%EF%B8%8F-how-it-works)
9+
- [How It Works](#%EF%B8%8F-how-it-works)
10+
- [Development](#-development)
1011

1112
## ⚡️ Getting Started
1213

@@ -39,7 +40,7 @@ yarn add netlify-plugin-cloudinary
3940

4041
By default, your images will served via the [fetch delivery method](https://cloudinary.com/documentation/fetch_remote_images).
4142

42-
## 🧰 Configuration
43+
## 🛠 Configuration
4344

4445
### Plugin Inputs
4546

@@ -167,7 +168,7 @@ To provide comprehensive coverage of images being served from Cloudinary, we tak
167168

168169
Through this process, we're still able to afford the same option of using either the fetch or upload API depending on preference, where the latter would be uploaded if it's a new asset within the serverless function.
169170

170-
## Development
171+
## 🧰 Development
171172

172173
### Plugin
173174

@@ -196,6 +197,14 @@ Which will combine the build and deploy contexts and run through the full proces
196197

197198
The repository additionally includes a demo which uses the plugin. The demo is a simple Next.js application that lows a few images statically and those same images in a separate list once the page loads. This helps us test both the on-page image replacement and the redirecting of the images directory.
198199

200+
You can link this project to your Netlify account for testing purposes by creating a new Netlify site in the root of this project and linking it to that new site.
201+
202+
Once linked, you can then run the build and deploy process with:
203+
204+
```
205+
netlify deploy --build
206+
```
207+
199208
### Tests
200209

201210
Tests require all environment variables to be actively set in order to pass. See [configuration](#-configuration) above to see which variables need to be set.

0 commit comments

Comments
 (0)