docs: improve readme [skip ci]

2021-11-12 23:21:16 -05:00
parent a3742d95fc
commit a1909430f3
38 changed files with 487 additions and 449 deletions
--- a/source/plugins/achievements/README.md
+++ b/source/plugins/achievements/README.md
@@ -7,7 +7,7 @@ The *achievements* plugin displays several highlights about what you achieved on
    <details open><summary>Compact display</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.achievements.compact.svg">
    </details>
-    <details open><summary>Detailed display</summary>
+    <details><summary>Detailed display</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.achievements.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/achievements/metadata.yml
+++ b/source/plugins/achievements/metadata.yml
@@ -1,6 +1,6 @@
 name: "🏆 Achievements"
 category: github
-index: 17
+index: 14
 supports:
  - user
  - organization
--- a/source/plugins/activity/metadata.yml
+++ b/source/plugins/activity/metadata.yml
@@ -1,6 +1,6 @@
 name: "📰 Recent activity"
 category: github
-index: 16
+index: 13
 supports:
  - user
  - organization
--- a/source/plugins/anilist/README.md
+++ b/source/plugins/anilist/README.md
@@ -4,11 +4,13 @@ The *anilist* plugin lets you display your favorites animes, mangas and characte

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.svg">
-    <details><summary>Manga version</summary>
+    <details open><summary>For anime watchers</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.svg">
+    </details>
+    <details><summary>For manga readers</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.manga.svg">
    </details>
-    <details open><summary>Favorites characters version</summary>
+    <details open><summary>Favorites characters</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.characters.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/code/metadata.yml
+++ b/source/plugins/code/metadata.yml
@@ -1,6 +1,6 @@
 name: "♐ Code snippet of the day"
 category: github
-index: 22
+index: 12
 supports:
  - user
  - organization
--- a/source/plugins/contributors/README.md
+++ b/source/plugins/contributors/README.md
@@ -6,11 +6,10 @@ It's especially useful to acknowledge contributors on release notes.

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.categories.svg">
-    <details><summary>Raw list with names</summary>
-      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.svg">
+    <details open><summary>By contribution types</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.categories.svg">
    </details>
-    <details><summary>With number of contributions</summary>
+    <details><summary>By number of contributions</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.contributions.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/contributors/metadata.yml
+++ b/source/plugins/contributors/metadata.yml
@@ -1,6 +1,6 @@
 name: "🏅 Repository contributors"
 category: github
-index: 5
+index: 6
 supports:
  - repository
 inputs:
--- a/source/plugins/discussions/metadata.yml
+++ b/source/plugins/discussions/metadata.yml
@@ -1,6 +1,6 @@
 name: "💬 Discussions"
 category: github
-index: 18
+index: 16
 supports:
  - user
 inputs:
--- a/source/plugins/followup/README.md
+++ b/source/plugins/followup/README.md
@@ -4,8 +4,13 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.svg">
-    <details><summary>Created by user version</summary>
+    <details open><summary>Indepth analysis</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.indepth.svg">
+    </details>
+    <details><summary>Created on an user's repositories</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.svg">
+    </details>
+    <details><summary>Created by an user</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.user.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/followup/metadata.yml
+++ b/source/plugins/followup/metadata.yml
@@ -1,6 +1,6 @@
 name: "🎟️ Follow-up of issues and pull requests"
 category: github
-index: 11
+index: 7
 supports:
  - user
  - organization
--- a/source/plugins/gists/metadata.yml
+++ b/source/plugins/gists/metadata.yml
@@ -1,6 +1,6 @@
 name: "🎫 Gists"
 category: github
-index: 10
+index: 21
 supports:
  - user
 inputs:
--- a/source/plugins/habits/README.md
+++ b/source/plugins/habits/README.md
@@ -4,10 +4,12 @@ The coding *habits* plugin display metrics based on your recent activity, such a

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.habits.facts.svg">
-    <details open><summary>Charts version</summary>
+    <details open><summary>Recent activity charts</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.habits.charts.svg">
    </details>
+    <details open><summary>Midly interesting facts</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.habits.facts.svg">
+    </details>
    <img width="900" height="1" alt="">
  </td>
 </table>
--- a/source/plugins/habits/metadata.yml
+++ b/source/plugins/habits/metadata.yml
@@ -1,6 +1,6 @@
 name: "💡 Coding habits"
 category: github
-index: 3
+index: 5
 supports:
  - user
  - organization
--- a/source/plugins/introduction/README.md
+++ b/source/plugins/introduction/README.md
@@ -5,10 +5,10 @@ It is mostly intended for metrics used outside of GitHub, since these informatio

 <table>
  <td align="center">
-    <details open><summary>Account version</summary>
+    <details open><summary>For an user or an organization</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.svg">
    </details>
-    <details open><summary>Repository version</summary>
+    <details><summary>For a repository</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.repository.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/introduction/metadata.yml
+++ b/source/plugins/introduction/metadata.yml
@@ -1,6 +1,6 @@
 name: "🙋 Introduction"
 category: github
-index: 2
+index: 22
 supports:
  - user
  - organization
--- a/source/plugins/isocalendar/README.md
+++ b/source/plugins/isocalendar/README.md
@@ -4,8 +4,10 @@ The *isocalendar* plugin displays an isometric view of your commits calendar, al

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg">
-    <details open><summary>Full year version</summary>
+    <details open><summary>Full year isometric calendar</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg">
+    </details>
+    <details><summary>Half year isometric calendar</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/languages/README.md
+++ b/source/plugins/languages/README.md
@@ -4,15 +4,17 @@ The *languages* plugin displays which programming languages you use the most acr

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg">
-    <details open><summary>With both total bytes size and percentage version</summary>
-      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg">
+    <details open><summary>Indepth analysis (clone and analyze repositories)</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.indepth.svg">
    </details>
-    <details open><summary>Recently used version (based on recent activity)</summary>
+    <details open><summary>Recently used (analyze recent activity events)</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg">
    </details>
-    <details><summary>Indepth analysis (clone, analyze and extract commits)</summary>
-      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.indepth.svg">
+    <details><summary>Default algorithm</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg">
+    </details>
+    <details><summary>Default algorithm (with details)</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg">
    </details>
    <img width="900" height="1" alt="">
  </td>
--- a/source/plugins/licenses/README.md
+++ b/source/plugins/licenses/README.md
@@ -10,8 +10,10 @@ The *licenses* plugin lets you display license informations like permissions, li

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.licenses.svg">
-    <details><summary>With licenses ratio</summary>
+    <details open><summary>Permissions, limitations and conditions</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.licenses.svg">
+    </details>
+    <details open><summary>Licenses overview</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.licenses.ratio.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/lines/metadata.yml
+++ b/source/plugins/lines/metadata.yml
@@ -1,6 +1,6 @@
 name: "👨‍💻 Lines of code changed"
 category: github
-index: 12
+index: 18
 supports:
  - user
  - organization
--- a/source/plugins/music/README.md
+++ b/source/plugins/music/README.md
@@ -4,10 +4,10 @@ The *music* plugin lets you display :

 <table>
  <td align="center">
-    <details open><summary>🎼 Favorite tracks version</summary>
+    <details open><summary>Random tracks from a playlist</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.music.playlist.svg">
    </details>
-    <details open><summary>Recently listened version</summary>
+    <details open><summary>Recently listened</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.music.recent.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/notable/README.md
+++ b/source/plugins/notable/README.md
@@ -4,13 +4,12 @@ The *notable* plugin displays badges of organization where you commited at least

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.svg">
-    <details><summary>With repository name</summary>
-      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.repositories.svg">
-    </details>
    <details open><summary>Indepth analysis</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.indepth.svg">
    </details>
+    <details><summary>Contributions in organizations only</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.svg">
+    </details>
    <img width="900" height="1" alt="">
  </td>
 </table>
--- a/source/plugins/notable/metadata.yml
+++ b/source/plugins/notable/metadata.yml
@@ -1,6 +1,6 @@
 name: "🎩 Notable contributions"
 category: github
-index: 20
+index: 15
 supports:
  - user
 inputs:
--- a/source/plugins/pagespeed/README.md
+++ b/source/plugins/pagespeed/README.md
@@ -5,11 +5,13 @@ The *pagespeed* plugin adds the performance statistics of the website attached o

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.svg">
-    <details><summary>Detailed version</summary>
+    <details open><summary>PageSpeed scores</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.svg">
+    </details>
+    <details><summary>PageSpeed scores with detailed report</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.detailed.svg">
    </details>
-    <details><summary>With screenshot version</summary>
+    <details><summary>PageSpeed scores with a website screenshot</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.screenshot.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/people/README.md
+++ b/source/plugins/people/README.md
@@ -5,14 +5,10 @@ In repository mode, it's possible to display sponsors, stargazers, watchers.

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.followers.svg">
-    <details><summary>Followed people version</summary>
-      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.following.svg">
+    <details open><summary>Related to an user</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.followers.svg">
    </details>
-    <details><summary>Special thanks version</summary>
-      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.thanks.svg">
-    </details>
-    <details><summary>Repository template version</summary>
+    <details><summary>Related to a repository</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.repository.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/posts/README.md
+++ b/source/plugins/posts/README.md
@@ -4,8 +4,10 @@ The recent *posts* plugin displays recent articles you wrote on an external sour

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg">
-    <details><summary>With posts descriptions and cover images version</summary>
+    <details open><summary>Latest posts</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg">
+    </details>
+    <details><summary>Latest posts width description and cover image</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.full.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/projects/metadata.yml
+++ b/source/plugins/projects/metadata.yml
@@ -1,6 +1,6 @@
 name: "🗂️ Active projects"
 category: github
-index: 15
+index: 11
 supports:
  - user
  - organization
--- a/source/plugins/repositories/metadata.yml
+++ b/source/plugins/repositories/metadata.yml
@@ -1,6 +1,6 @@
 name: "📓 Repositories"
 category: github
-index: 21
+index: 20
 supports:
  - user
  - organization
--- a/source/plugins/sponsors/README.md
+++ b/source/plugins/sponsors/README.md
@@ -4,8 +4,10 @@ The *sponsors* plugin lets you display your sponsors and introduction text from

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.sponsors.svg">
-    <details><summary>With GitHub sponsors introduction</summary>
+    <details open><summary>GitHub sponsors card</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.sponsors.svg">
+    </details>
+    <details><summary>GitHub sponsors full introduction</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.sponsors.full.svg">
    </details>
    <img width="900" height="1" alt="">
--- a/source/plugins/stargazers/metadata.yml
+++ b/source/plugins/stargazers/metadata.yml
@@ -1,6 +1,6 @@
 name: "✨ Stargazers over last weeks"
 category: github
-index: 14
+index: 10
 supports:
  - user
  - organization
--- a/source/plugins/stars/metadata.yml
+++ b/source/plugins/stars/metadata.yml
@@ -1,6 +1,6 @@
 name: "🌟 Recently starred repositories"
 category: github
-index: 6
+index: 3
 supports:
  - user
 inputs:
--- a/source/plugins/support/metadata.yml
+++ b/source/plugins/support/metadata.yml
@@ -1,6 +1,6 @@
 name: "💭 GitHub Community Support"
 category: github
-index: 19
+index: 17
 supports:
  - user
 inputs:
--- a/source/plugins/topics/README.md
+++ b/source/plugins/topics/README.md
@@ -5,10 +5,12 @@ Check out [GitHub topics](https://github.com/topics) to search interesting topic

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg">
-    <details open><summary>With icons instead</summary>
+    <details open><summary>With icons</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.icons.svg">
    </details>
+    <details open><summary>With labels</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg">
+    </details>
    <img width="900" height="1" alt="">
  </td>
 </table>
--- a/source/plugins/topics/metadata.yml
+++ b/source/plugins/topics/metadata.yml
@@ -1,6 +1,6 @@
 name: "📌 Starred topics"
 category: github
-index: 7
+index: 2
 supports:
  - user
 inputs:
--- a/source/plugins/traffic/metadata.yml
+++ b/source/plugins/traffic/metadata.yml
@@ -1,6 +1,6 @@
 name: "🧮 Repositories traffic"
 category: github
-index: 13
+index: 19
 supports:
  - user
  - organization
--- a/source/plugins/tweets/README.md
+++ b/source/plugins/tweets/README.md
@@ -4,8 +4,10 @@ The recent *tweets* plugin displays your latest tweets from your [Twitter](https

 <table>
  <td align="center">
-    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.svg">
-    <details><summary>With tweets attachments version</summary>
+    <details open><summary>Latest tweets</summary>
+      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.svg">
+    </details>
+    <details><summary>Latest tweets with attachments</summary>
      <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.attachments.svg">
    </details>
    <img width="900" height="1" alt="">