docs(readme): update domain to be optional

imgix · Feb 6, 2023 · 44ab723 · 44ab723
1 parent a18fbb7
commit 44ab723
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -124,15 +124,16 @@ module.exports = {
       options: {
         // This is the domain of your imgix source, which can be created at
         // https://dashboard.imgix.com/.
-        // Only "Web Proxy" imgix sources can be used for this configuration.
+        // Required for "Web Proxy" imgix sources.
         domain: 'example.imgix.net',
 
         // This is the source's secure token. Can be found under the "Security"
         // heading in your source's configuration page, and revealed by tapping
-        // "Show Token".
+        // "Show Token". Required for web-proxy sources.
         secureURLToken: 'abcABC123',
 
         // This configures the plugin to work in proxy mode.
+        // Can be AmazonS3, GoogleCloudStorage, MicrosoftAzure, or WebFolder.
         sourceType: ImgixSourceType.WebProxy,
 
         // These are some default imgix parameters to set for each image. It is
@@ -815,7 +816,7 @@ The plugin options that can be specified in `gatsby-config.js` are:
 
 | Name                 | Type      | Required | Description                                                                                                                                                     |
 | :------------------- | :-------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `domain`             | `String`  | ✔️       | The imgix domain to use for the image URLs. Usually in the format `.imgix.net`                                                                                  |
+| `domain`             | `String`  |          | The imgix domain to use for the image URLs. Usually in the format `.imgix.net`                                                                                  |
 | `defaultImgixParams` | `Object`  |          | Imgix parameters to use by default for every image. Recommended to set to `{ auto: ['compress', 'format'] }`.                                                   |
 | `disableIxlibParam`  | `Boolean` |          | Set to `true` to remove the `ixlib` param from every request. See [this section](#what-is-the-ixlib-param-on-every-request) for more information.               |
 | `secureURLToken`     | `String`  |          | When specified, this token will be used to sign images. Read more about securing images [on the imgix Docs site](https://docs.imgix.com/setup/securing-images). |
@@ -1129,7 +1130,7 @@ module.exports = {
     {
       resolve: `@imgix/gatsby`,
       options: {
-        domain: 'domain.imgix.net>',
+        domain: '<domain.imgix.net>',
         disableIxlibParam: 'true', // this disables the ixlib parameter
         defaultImgixParams: { auto: ['compress', 'format'] },
       },