Merge branch 'master' of https://github.com/lowlighter/metrics

source/plugins/core/README.md

@@ -53,6 +53,38 @@ Content can be manually ordered using `config_order` option.
 
 > 💡 Omitted sections will be appended at the end using default order
 
+## 🪛 Using presets
+
+> 🚧 This feature is an early implementation and may change before official release
+
+It is possible to reuse the same configuration across different repositories and workflows using configuration presets.
+A preset override the default values of inputs, and multiple presets can be provided at once through URLs or file paths.
+
+Options resolution is done in the following order:
+- default values
+- presets, from first to last
+- user values
+
+*Example: using a configuration preset from an url*
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    config_presets: https://raw.githubusercontent.com/lowlighter/metrics/presets/lunar-red/preset.yaml
+```
+
+Some presets are hosted on this repository on the [`@presets`](https://github.com/lowlighter/metrics/tree/presets) branch and can be used directly by using using their identifier prefixed by an arobase (`@`).
+
+*Example: using a pre-defined configuration preset*
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    config_presets: "@lunar-red"
+```
+
+> ⚠️ `🔐 Tokens` and options marked with `⏯️ Cannot be preset`, as they suggest, cannot be preset and thus requires to be explicitely defined to be set.
+
+> ℹ️ Presets configurations use [schemas](https://github.com/lowlighter/metrics/tree/presets/%40schema) to ensure compatibility between format changes
+
 ## 🎨 Custom CSS styling
 
 Additional CSS can be injected using `extras_css` option.