Mirror of
docs: update README.md to include imageFormat and add notice for default values
+11
-3
+11
-3
README.md
+11
-3
README.md
···
3
3
Get your random default image from [https://release-image-generator.trueberryless.org/](https://release-image-generator.trueberryless.org/) and adjust some parameters in the URL:
4
4
5
5
- **text**: Configure the text display in the middle of the image: [https://release-image-generator.trueberryless.org?text=2.0](https://release-image-generator.trueberryless.org?text=2.0), by default there is no text
6
-
- **width** & **height**: Configure the width and height of the image: [https://release-image-generator.trueberryless.org?width=1560&height=640](https://release-image-generator.trueberryless.org?width=1560&height=640)
6
+
- **width** & **height**: Configure the width and height of the image (default: 1920x1080): [https://release-image-generator.trueberryless.org?width=1560&height=640](https://release-image-generator.trueberryless.org?width=1560&height=640)
7
7
- **primaryColor**: Set the HEX value of the desired primary color (with or without the octothorpe - escape `#` with `%23`); example with pink: [https://release-image-generator.trueberryless.org/?text=1.0&primaryColor=%23ffc0d2](https://release-image-generator.trueberryless.org/?text=1.0&primaryColor=%23ffc0d2)
8
+
- **imageFormat**: Define the desired image output format.: [https://release-image-generator.trueberryless.org?text=1.0&imageFormat=jpg](https://release-image-generator.trueberryless.org?text=1.0&imageFormat=jpg)
9
+
10
+
Image Format Options:
11
+
12
+
- `png` (default)
13
+
- `jpg` / `jpeg`
14
+
- `webp`
15
+
8
16
- **fontFamily** & **fontWeight**: Configure the font family and weight used: [https://release-image-generator.trueberryless.org?text=1.0&fontFamily=jetbrainsmono&fontWeight=bold](https://release-image-generator.trueberryless.org?text=1.0&fontFamily=jetbrainsmono&fontWeight=bold)
9
17
10
18
Family Options:
···
17
25
- `poppins`
18
26
- `quicksand`
19
27
- `raleway`
20
-
- `readexpro`
28
+
- `readexpro` (default)
21
29
- `roboto`
22
30
- `robotomono`
23
31
- `rubik`
···
25
33
26
34
Weight Options:
27
35
28
-
- `bold`
36
+
- `bold` (default)
29
37
- `medium`
30
38
- `light`
31
39