From e9ee0334bcc3f5064de5377bc2a206450e7625a7 Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Sat, 2 Jan 2021 15:46:46 +0100 Subject: [PATCH] Update README.md --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 904a9598..25d6e2e1 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
With charts version - +
@@ -1236,6 +1236,56 @@ Add the following to your workflow : +### 🔧 Other options + +A few additional options are available. +See all supported options in [action.yml](action.yml). + +
+💬 About + +#### 🌐 Set timezone + +By default, dates are based on the Greenwich meridian (England time). + +It is possible to set set your timezone (see [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for a list of supported timezones) by adding the following to your workflow : + +```yaml +- uses: lowlighter/metrics@latest + with: + # ... other options + config_timezone: Europe/Paris +``` + +#### 🔲 Adjust padding + +Generated metrics height is computed after being rendered through an headless browser. As rendering can depends on used fonts and operating system, it may render as cropped or with additional blank space at the bottom. + +It is possible to adjust the padding by adding the following to your workflow : +```yaml +- uses: lowlighter/metrics@latest + with: + # ... other options + config_padding: 6% +``` + +Both positive and negative values are accepted, but you must specify a percentage. + +#### 💱 Convert output to PNG/JPEG + +It is possible to convert output from SVG to PNG or JPEG images by adding the following to your workflow : +```yaml +- uses: lowlighter/metrics@latest + with: + # ... other options + config_output: png +``` + +Note that `png` does not support animations while `jpeg` does not support both animations and transparency. + +
+ + ## 💪 Contributing and customizing To suggest a new feature, find a bug or need help, fill an [issue](https://github.com/lowlighter/metrics/issues) describing your problem or your needs.