chore: updated documentation

mauricerenck · Dec 1, 2023 · 91860f7 · 91860f7
1 parent 6e1d3e4
commit 91860f7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,6 @@ Use one of these three methods to install the plugin:
 
 - `composer require mauricerenck/pexelsimagefield`
 - unzip [master.zip](https://github.com/mauricerenck/pexels-image-field/releases/latest) to `site/plugins/pexels-image-field`
-- `git submodule add https://github.com/mauricerenck/pexels-image-field.git site/plugins/pexels-image-field`
 
 * [Setup the plugin](docs/setup.md)
 * [See all options](docs/options.md)

diff --git a/docs/options.md b/docs/options.md
@@ -1,4 +1,5 @@
-| option | default | description                            |
-| ------ | ------- | -------------------------------------- |
-| images | 12      | Set a number of images                 |
-| apiKey | ''      | See: https://www.pexels.com/de-de/api/ |
+| option       | default | description                                                             |
+| ------------ | ------- | ----------------------------------------------------------------------- |
+| images       | 12      | Set a number of images                                                  |
+| apiKey       | ''      | See: https://www.pexels.com/de-de/api/                                  |
+| downloadSize | 'large' | 'tiny', 'small', 'medium', 'large', 'portrait', 'landscape', 'original' |
diff --git a/docs/setup.md b/docs/setup.md
@@ -11,4 +11,5 @@ fields:
     label: Pexels
 ```
 
-You can modify the number of images shown using `'mauricerenck.PexelsImageField.images' => '12'`
+You can modify the number of images shown using `'mauricerenck.PexelsImageField.images' => '12'`
+You can modify the size of the downloaded image using `'mauricerenck.PexelsImageField.downloadSize' => 'medium'` (see options for all sizes)