From 32a90c5375ccec14f6635f067a516350f5cb1b0a Mon Sep 17 00:00:00 2001 From: linguist <22963968+lowlighter@users.noreply.github.com> Date: Thu, 31 Dec 2020 14:28:43 +0100 Subject: [PATCH] Rename GitHub metrics to Metrics --- CONTRIBUTING.md | 2 +- README.md | 16 ++++++++-------- source/app/action/index.mjs | 3 ++- source/app/web/statics/app.js | 4 ++-- source/app/web/statics/index.html | 2 +- source/templates/terminal/image.svg | 2 +- 6 files changed, 15 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b21c6d4..5caf0e0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# 📊 GitHub metrics +# 📊 Metrics ## 💪 Interested in contributing ? diff --git a/README.md b/README.md index 55eeda0f..e0d30750 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# 📊 GitHub metrics +# 📊 Metrics ![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg) Generates your metrics that you can embed everywhere ! -[![GitHub metrics](https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg)](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/src/plugins) and [templates](https://github.com/lowlighter/metrics/tree/master/src/templates) ! @@ -214,7 +214,7 @@ See all supported options in [action.yml](action.yml). Assuming your username is `my-github-user`, you can then embed your metrics in your repository readme like below : ```markdown -![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) +![Metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) ```
@@ -258,7 +258,7 @@ Go to the `Settings` of your personal repository to create a new secret and past Create a new workflow from the `Actions` tab of your personal repository and paste the following : ```yaml -name: GitHub metrics +name: Metrics on: # Schedule updates schedule: [{cron: "0 * * * *"}] @@ -306,7 +306,7 @@ Note that most of steps presented there are illustrative examples for this readm Edit your repository readme and add your metrics image : ```markdown -![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) +![Metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) ```
@@ -318,7 +318,7 @@ For conveniency, you can use the shared instance available at [metrics.lecoq.io] Assuming your username is `my-github-user`, you can embed your metrics in your repository readme like below : ```markdown -![GitHub metrics](https://metrics.lecoq.io/my-github-user) +![Metrics](https://metrics.lecoq.io/my-github-user) ``` Visit [metrics.lecoq.io](https://metrics.lecoq.io) for more informations. @@ -401,7 +401,7 @@ From your browser, you should be able to access your web instance on the port yo Edit your repository readme and add your metrics image from your server domain : ```markdown -![GitHub metrics](https://my-personal-domain.com/my-github-user) +![Metrics](https://my-personal-domain.com/my-github-user) ``` ### 6. (optional) Setup as service on your instance @@ -413,7 +413,7 @@ Create a new service file `/etc/systemd/system/github_metrics.service` and paste ``` [Unit] -Description=GitHub metrics +Description=Metrics After=network-online.target Wants=network-online.target diff --git a/source/app/action/index.mjs b/source/app/action/index.mjs index 2493eb2c..93a7ac99 100644 --- a/source/app/action/index.mjs +++ b/source/app/action/index.mjs @@ -14,7 +14,8 @@ //Runner try { //Initialization - console.log(`GitHub metrics`) + console.log("─".repeat(64)) + console.log(`Metrics`) console.log("─".repeat(64)) process.on("unhandledRejection", error => { throw error }) diff --git a/source/app/web/statics/app.js b/source/app/web/statics/app.js index d2908d6c..beee8238 100644 --- a/source/app/web/statics/app.js +++ b/source/app/web/statics/app.js @@ -118,13 +118,13 @@ }, //Embedded generated code embed() { - return `![GitHub metrics](${this.url})` + return `![Metrics](${this.url})` }, //GitHub action auto-generated code action() { return [ `# Visit https://github.com/lowlighter/metrics/blob/master/action.yml for full reference`, - `name: GitHub metrics`, + `name: Metrics`, `on:`, ` # Schedule updates`, ` schedule: [{cron: "0 * * * *"}]`, diff --git a/source/app/web/statics/index.html b/source/app/web/statics/index.html index 75fb5f26..b950e206 100644 --- a/source/app/web/statics/index.html +++ b/source/app/web/statics/index.html @@ -1,7 +1,7 @@ - GitHub metrics + Metrics diff --git a/source/templates/terminal/image.svg b/source/templates/terminal/image.svg index ea1acd4d..cc59bb46 100644 --- a/source/templates/terminal/image.svg +++ b/source/templates/terminal/image.svg @@ -57,7 +57,7 @@
<%# -%>
 <% if (base.metadata) { %>