From 589aa2d9aea1d4e9bd87d7ffa46871de53eee6c7 Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Tue, 26 Jan 2021 18:54:28 +0100 Subject: [PATCH] Update README.md --- README.md | 140 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 78 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index c9fef052..b6cfdb07 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ ![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg) -Generate your metrics that you can embed everywhere, including your GitHub profile readme! +Generate your metrics that you can embed everywhere, including your GitHub profile readme! It works for both user and organization accounts! + +[Metrics (user account)](https://metrics.lecoq.io) +[Metrics (organization account)](https://metrics.lecoq.io) -[![Metrics](https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg)](https://metrics.lecoq.io) But there's more with [plugins](https://github.com/lowlighter/metrics/tree/master/source/plugins) and [templates](https://github.com/lowlighter/metrics/tree/master/source/templates)! @@ -585,70 +587,70 @@ The default template is `classic`. 🌸 - Classic - ✔️ - ✔️ - ✔️ - ✔️N - ✔️N - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️N - ✔️N - ✔️M + Classic + ✔️ + ✔️ + ✔️ + ✔️N + ✔️N + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️N + ✔️N + ✔️M - Terminal - ✔️P - ✔️ - ❌ - ❌ - ✔️ - ✔️ - ❌ - ❌ - ✔️ - ✔️ - ❌ - ❌ - ❌ - ❌ - ❌ - ❌ - ✔️N - ❌ - ❌ + Terminal + ✔️P + ✔️ + ❌ + ❌ + ✔️ + ✔️ + ❌ + ❌ + ✔️ + ✔️ + ❌ + ❌ + ❌ + ❌ + ❌ + ❌ + ✔️N + ❌ + ❌ - RepositoryR - ✔️ - ✔️ - ❌ - ❌ - ✔️ - ✔️ - ❌ - ✔️ - ✔️ - ✔️ - ❌ - ❌ - ❌ - ❌ - ❌ - ✔️ - ❌ - ✔️M - ❌ + RepositoryR + ✔️ + ✔️ + ❌ + ❌ + ✔️ + ✔️ + ❌ + ✔️ + ✔️ + ✔️ + ❌ + ❌ + ❌ + ❌ + ❌ + ✔️ + ❌ + ✔️M + ❌ @@ -720,6 +722,9 @@ Add the following to your workflow: 🚧 This feature is available as pre-release on @master branch (unstable) It is also possible to generate metrics for organization accounts. + +![Metrics (organization account)](https://github.com/lowlighter/lowlighter/blob/master/metrics.organization.svg) + Setup is the same as for user accounts (i.e. a personal token from an user account and use of `GITHUB_TOKEN` for commits) but you'll need to change `user` option to your organization name. Additionally, you'll need to add the `read:org` scope to your personal token, *whether you're member of target organization or not*. @@ -1767,6 +1772,17 @@ Note that `png` does not support animations while `jpeg` does not support both a +## 🗓️ Release schedule + +New features and fixes are always available first on `@master` branch which acts as development branch. +You can use this branch if you don't mind having your metrics workflow failing from time to time. +Fork this repository if you want to manage head commit yourself and ensure you're always on a working version of metrics. + +When both [Planned for next release](https://github.com/lowlighter/metrics/projects/1#column-12378679) and [In progress](https://github.com/lowlighter/metrics/projects/1#column-12158618) project columns are empty, a new version of metrics will be released soon after. + +`@latest` tag wil be updated to latest release of metrics, which means it doesn't required any action from your side if you're using this tag. +New releases (even majors versions) never introduce breaking changes from an user point of view, so you can flawlessy follow release cycles without worrying. +Hot fixes may be applied after releases without changing version number. ## 💪 Contributing and customizing