Rename GitHub metrics to Metrics

This commit is contained in:
linguist
2020-12-31 14:28:43 +01:00
parent d05c83fa77
commit 32a90c5375
6 changed files with 15 additions and 14 deletions

View File

@@ -1,4 +1,4 @@
# 📊 GitHub metrics # 📊 Metrics
## 💪 Interested in contributing ? ## 💪 Interested in contributing ?

View File

@@ -1,10 +1,10 @@
# 📊 GitHub metrics # 📊 Metrics
![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg) ![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg)
Generates your metrics that you can embed everywhere ! 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) ! 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 : Assuming your username is `my-github-user`, you can then embed your metrics in your repository readme like below :
```markdown ```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)
``` ```
<details> <details>
@@ -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 : Create a new workflow from the `Actions` tab of your personal repository and paste the following :
```yaml ```yaml
name: GitHub metrics name: Metrics
on: on:
# Schedule updates # Schedule updates
schedule: [{cron: "0 * * * *"}] 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 : Edit your repository readme and add your metrics image :
```markdown ```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)
``` ```
</details> </details>
@@ -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 : Assuming your username is `my-github-user`, you can embed your metrics in your repository readme like below :
```markdown ```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. 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 : Edit your repository readme and add your metrics image from your server domain :
```markdown ```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 ### 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] [Unit]
Description=GitHub metrics Description=Metrics
After=network-online.target After=network-online.target
Wants=network-online.target Wants=network-online.target

View File

@@ -14,7 +14,8 @@
//Runner //Runner
try { try {
//Initialization //Initialization
console.log(`GitHub metrics`) console.log("─".repeat(64))
console.log(`Metrics`)
console.log("─".repeat(64)) console.log("─".repeat(64))
process.on("unhandledRejection", error => { throw error }) process.on("unhandledRejection", error => { throw error })

View File

@@ -118,13 +118,13 @@
}, },
//Embedded generated code //Embedded generated code
embed() { embed() {
return `![GitHub metrics](${this.url})` return `![Metrics](${this.url})`
}, },
//GitHub action auto-generated code //GitHub action auto-generated code
action() { action() {
return [ return [
`# Visit https://github.com/lowlighter/metrics/blob/master/action.yml for full reference`, `# Visit https://github.com/lowlighter/metrics/blob/master/action.yml for full reference`,
`name: GitHub metrics`, `name: Metrics`,
`on:`, `on:`,
` # Schedule updates`, ` # Schedule updates`,
` schedule: [{cron: "0 * * * *"}]`, ` schedule: [{cron: "0 * * * *"}]`,

View File

@@ -1,7 +1,7 @@
<html> <html>
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>GitHub metrics</title> <title>Metrics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A SVG image generator which includes activity, community and repositories metrics about your GitHub account that you can includes on your profile"> <meta name="description" content="A SVG image generator which includes activity, community and repositories metrics about your GitHub account that you can includes on your profile">
<meta name="author" content="lowlighter"> <meta name="author" content="lowlighter">

View File

@@ -57,7 +57,7 @@
<pre><%# -%> <pre><%# -%>
<% if (base.metadata) { %> <% if (base.metadata) { %>
<div class="banner"><%# -%> <div class="banner"><%# -%>
GitHub metrics generator <%= meta.version %> Metrics generator <%= meta.version %>
These generated metrics comes with ABSOLUTELY NO These generated metrics comes with ABSOLUTELY NO
WARRANTY, to the extent permitted by applicable law. WARRANTY, to the extent permitted by applicable law.

Before

Width:  |  Height:  |  Size: 9.8 KiB

After

Width:  |  Height:  |  Size: 9.8 KiB