From a1909430f33f8f2f9b6c643a6b7a210e4fe21cc6 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Fri, 12 Nov 2021 23:21:16 -0500 Subject: [PATCH] docs: improve readme [skip ci] --- README.md | 425 ++++++++++++----------- action.yml | 302 ++++++++-------- settings.example.json | 58 ++-- source/plugins/achievements/README.md | 2 +- source/plugins/achievements/metadata.yml | 2 +- source/plugins/activity/metadata.yml | 2 +- source/plugins/anilist/README.md | 8 +- source/plugins/code/metadata.yml | 2 +- source/plugins/contributors/README.md | 7 +- source/plugins/contributors/metadata.yml | 2 +- source/plugins/discussions/metadata.yml | 2 +- source/plugins/followup/README.md | 9 +- source/plugins/followup/metadata.yml | 2 +- source/plugins/gists/metadata.yml | 2 +- source/plugins/habits/README.md | 6 +- source/plugins/habits/metadata.yml | 2 +- source/plugins/introduction/README.md | 4 +- source/plugins/introduction/metadata.yml | 2 +- source/plugins/isocalendar/README.md | 6 +- source/plugins/languages/README.md | 14 +- source/plugins/licenses/README.md | 6 +- source/plugins/lines/metadata.yml | 2 +- source/plugins/music/README.md | 4 +- source/plugins/notable/README.md | 7 +- source/plugins/notable/metadata.yml | 2 +- source/plugins/pagespeed/README.md | 8 +- source/plugins/people/README.md | 10 +- source/plugins/posts/README.md | 6 +- source/plugins/projects/metadata.yml | 2 +- source/plugins/repositories/metadata.yml | 2 +- source/plugins/sponsors/README.md | 6 +- source/plugins/stargazers/metadata.yml | 2 +- source/plugins/stars/metadata.yml | 2 +- source/plugins/support/metadata.yml | 2 +- source/plugins/topics/README.md | 6 +- source/plugins/topics/metadata.yml | 2 +- source/plugins/traffic/metadata.yml | 2 +- source/plugins/tweets/README.md | 6 +- 38 files changed, 487 insertions(+), 449 deletions(-) diff --git a/README.md b/README.md index 7b330063..eaaa3a8e 100644 --- a/README.md +++ b/README.md @@ -40,84 +40,96 @@ And you can customize these heavily with plugins, templates and hundreds of opti - -
Full year version +
Full year isometric calendar + +
+
Half year isometric calendar
- -
With both total bytes size and percentage version - -
-
Recently used version (based on recent activity) - -
-
Indepth analysis (clone, analyze and extract commits) +
Indepth analysis (clone and analyze repositories)
+
Recently used (analyze recent activity events) + +
+
Default algorithm + +
+
Default algorithm (with details) + +
- 🙋 Introduction - 💡 Coding habits + 📌 Starred topics + 🌟 Recently starred repositories -
Account version - +
With icons +
-
Repository version - +
With labels +
- -
Charts version - -
+ 📜 Repository licenses - 🏅 Repository contributors + 💡 Coding habits - -
With licenses ratio +
Permissions, limitations and conditions + +
+
Licenses overview
- -
Raw list with names - +
Recent activity charts +
-
With number of contributions +
Midly interesting facts + +
+ + + + + 🏅 Repository contributors + 🎟️ Follow-up of issues and pull requests + + + +
By contribution types + +
+
By number of contributions
- - - 🌟 Recently starred repositories - 📌 Starred topics - - - - - - - -
With icons instead - +
Indepth analysis + +
+
Created on an user's repositories + +
+
Created by an user +
@@ -132,49 +144,15 @@ And you can customize these heavily with plugins, templates and hundreds of opti - -
Followed people version - +
Related to an user +
-
Special thanks version - -
-
Repository template version +
Related to a repository
- - 🎫 Gists - 🎟️ Follow-up of issues and pull requests - - - - - - - - -
Created by user version - -
- - - - - 👨‍💻 Lines of code changed - 🧮 Repositories traffic - - - - - - - - - - ✨ Stargazers over last weeks 🗂️ Active projects @@ -190,23 +168,42 @@ And you can customize these heavily with plugins, templates and hundreds of opti + ♐ Code snippet of the day 📰 Recent activity - 🏆 Achievements + + + + + + + 🏆 Achievements + 🎩 Notable contributions + +
Compact display
-
Detailed display +
Detailed display
+ +
Indepth analysis + +
+
Contributions in organizations only + +
+ + 💬 Discussions @@ -223,37 +220,51 @@ And you can customize these heavily with plugins, templates and hundreds of opti - 🎩 Notable contributions - 📓 Repositories + 👨‍💻 Lines of code changed + 🧮 Repositories traffic - -
With repository name - -
-
Indepth analysis - -
+ + + + + + + 📓 Repositories + 🎫 Gists + + + + + + - ♐ Code snippet of the day + 🙋 Introduction 💕 GitHub Sponsors - +
For an user or an organization + +
+
For a repository + +
- -
With GitHub sponsors introduction +
GitHub sponsors card + +
+
GitHub sponsors full introduction
@@ -269,11 +280,13 @@ And you can customize these heavily with plugins, templates and hundreds of opti - -
Detailed version +
PageSpeed scores + +
+
PageSpeed scores with detailed report
-
With screenshot version +
PageSpeed scores with a website screenshot
@@ -285,17 +298,19 @@ And you can customize these heavily with plugins, templates and hundreds of opti -
🎼 Favorite tracks version +
Random tracks from a playlist
-
Recently listened version +
Recently listened
- -
With tweets attachments version +
Latest tweets + +
+
Latest tweets with attachments
@@ -307,11 +322,13 @@ And you can customize these heavily with plugins, templates and hundreds of opti - -
Manga version +
For anime watchers + +
+
For manga readers
-
Favorites characters version +
Favorites characters
@@ -327,8 +344,10 @@ And you can customize these heavily with plugins, templates and hundreds of opti - -
With posts descriptions and cover images version +
Latest posts + +
+
Latest posts width description and cover image
@@ -742,27 +761,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 🗃️ 📅 🈷️ - 🙋 - 💡 - 📜 - 🏅 - 🌟 📌 + 🌟 + 📜 + 💡 + 🏅 + 🎟️ 🎭 🧑‍🤝‍🧑 - 🎫 - 🎟️ - 👨‍💻 - 🧮 ✨ 🗂️ + ♐ 📰 🏆 + 🎩 💬 💭 - 🎩 + 👨‍💻 + 🧮 📓 - ♐ + 🎫 + 🙋 💕 🌇 ⏱️ @@ -782,27 +801,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ✔️ ✔️ - ✔️ - ✔️ - ❌ - ❌ - ✔️ ✔️ + ✔️ + ❌ + ✔️ + ❌ + ✔️ ✔️ ✔️ - ✔️ - ✔️ - ✔️ - ✔️ ✔️ ✔️ + ✔️ ✔️ ✔️ + ✔️ ✔️ ✔️ - ✔️ + ✔️ + ✔️ ✔️ - ✔️ + ✔️ + ✔️ ✔️ ✔️ ✔️ @@ -822,27 +841,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ❌ ✔️ - ✔️ - ❌ - ✔️ - ✔️ - ❌ ❌ + ❌ + ✔️ + ❌ + ✔️ + ✔️ ❌ ✔️ - ❌ - ✔️ - ✔️ - ✔️ ✔️ ✔️ + ❌ ✔️ ❌ + ❌ ❌ ❌ - ❌ + ✔️ + ✔️ ❌ - ❌ + ❌ + ✔️ ✔️ ❌ ✔️ @@ -862,27 +881,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ✔️ ✔️ - ❌ - ❌ - ❌ - ❌ - ❌ ❌ + ❌ + ❌ + ❌ + ❌ + ❌ ❌ ❌ - ✔️ - ❌ - ✔️ - ✔️ ❌ ❌ + ❌ ❌ ❌ + ❌ ❌ ❌ - ❌ + ✔️ + ✔️ ❌ - ❌ + ✔️ + ❌ ❌ ❌ ✔️ @@ -902,27 +921,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ✓ ✓ - ✓ - ✓ - ✓ - ✓ - ✓ ✔️ + ✓ + ✓ + ✓ + ✓ + ✓ ✓ ✓ - ✓ - ✓ - ✓ - ✓ ✓ ✓ + ✓ ✔️ ✓ + ✓ ✓ ✓ - ✓ + ✓ + ✓ ✓ - ✓ + ✓ + ✓ ✓ ✓ ✓ @@ -945,27 +964,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 🗃️ 📅 🈷️ - 🙋 - 💡 - 📜 - 🏅 - 🌟 📌 + 🌟 + 📜 + 💡 + 🏅 + 🎟️ 🎭 🧑‍🤝‍🧑 - 🎫 - 🎟️ - 👨‍💻 - 🧮 ✨ 🗂️ + ♐ 📰 🏆 + 🎩 💬 💭 - 🎩 + 👨‍💻 + 🧮 📓 - ♐ + 🎫 + 🙋 💕 🌇 ⏱️ @@ -985,27 +1004,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ✔️ ✔️ - ✔️ - ✔️ - ❌ - ❌ - ✔️ ✔️ + ✔️ + ❌ + ✔️ + ❌ + ✔️ ✔️ ✔️ - ✔️ - ✔️ - ✔️ - ✔️ ✔️ ✔️ + ✔️ ✔️ ✔️ + ✔️ ✔️ ✔️ - ✔️ + ✔️ + ✔️ ✔️ - ✔️ + ✔️ + ✔️ ✔️ ✔️ ✔️ @@ -1025,27 +1044,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ❌ ✔️ - ✔️ - ✔️ - ❌ - ❌ - ❌ ❌ + ❌ + ❌ + ✔️ + ❌ + ✔️ ❌ ✔️ - ❌ - ✔️ - ✔️ - ✔️ ✔️ ✔️ + ✔️ ✔️ ✔️ + ❌ ❌ ❌ - ❌ + ✔️ + ✔️ ✔️ - ✔️ + ❌ + ✔️ ✔️ ❌ ✔️ @@ -1065,27 +1084,27 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 ✔️ ❌ ✔️ - ✔️ - ❌ - ✔️ - ✔️ - ❌ ❌ + ❌ + ✔️ + ❌ + ✔️ + ✔️ ❌ ✔️ - ❌ - ✔️ - ✔️ - ✔️ ✔️ ✔️ + ❌ ✔️ ❌ + ❌ ❌ ❌ - ❌ + ✔️ + ✔️ ❌ - ❌ + ❌ + ✔️ ✔️ ❌ ✔️ diff --git a/action.yml b/action.yml index ebd6c785..a24cea95 100644 --- a/action.yml +++ b/action.yml @@ -377,16 +377,66 @@ inputs: default: 14 # ==================================================================================== - # 🙋 Introduction + # 📌 Starred topics # Enable or disable plugin - plugin_introduction: - description: Display account or repository introduction + plugin_topics: + description: Display starred topics default: no - # Display introduction section title - plugin_introduction_title: - description: Display introduction section title + # Plugin mode + plugin_topics_mode: + description: Plugin mode + default: starred + + # Topics sorting order + plugin_topics_sort: + description: Sorting method of starred topics + default: stars + + # Number of topics to display + # Set to 0 to disable limitations + # When in "starred" mode, additional topics will be grouped into an ellipsis + plugin_topics_limit: + description: Maximum number of topics to display + default: 15 + + # ==================================================================================== + # 🌟 Recently starred repositories + + # Enable or disable plugin + plugin_stars: + description: Display recently starred repositories + default: no + + # Number of stars to display + plugin_stars_limit: + description: Maximum number of stars to display + default: 4 + + # ==================================================================================== + # 📜 Repository licenses + + # Enable or disable plugin + plugin_licenses: + description: Display licenses informations + default: no + + # Command to use to setup target repository + # It is required to install all dependencies that will be analyzed with github/licensed + plugin_licenses_setup: + description: Command to setup target repository + default: "" + + # Display used licenses from both repository license and dependencies licenses ratio + plugin_licenses_ratio: + description: Display used licenses ratio + default: no + + # Display permissions, limitations and conditions from both repository license and dependencies licenses + # Note that this is NOT legal advice, use at your own risk + plugin_licenses_legal: + description: Display legal informations about used licenses default: yes # ==================================================================================== @@ -425,31 +475,6 @@ inputs: description: Trim unused hours on daily chart default: no - # ==================================================================================== - # 📜 Repository licenses - - # Enable or disable plugin - plugin_licenses: - description: Display licenses informations - default: no - - # Command to use to setup target repository - # It is required to install all dependencies that will be analyzed with github/licensed - plugin_licenses_setup: - description: Command to setup target repository - default: "" - - # Display used licenses from both repository license and dependencies licenses ratio - plugin_licenses_ratio: - description: Display used licenses ratio - default: no - - # Display permissions, limitations and conditions from both repository license and dependencies licenses - # Note that this is NOT legal advice, use at your own risk - plugin_licenses_legal: - description: Display legal informations about used licenses - default: yes - # ==================================================================================== # 🏅 Repository contributors @@ -499,43 +524,23 @@ inputs: } # ==================================================================================== - # 🌟 Recently starred repositories + # 🎟️ Follow-up of issues and pull requests # Enable or disable plugin - plugin_stars: - description: Display recently starred repositories + plugin_followup: + description: Display follow-up of repositories issues and pull requests default: no - # Number of stars to display - plugin_stars_limit: - description: Maximum number of stars to display - default: 4 + # Sections to display + plugin_followup_sections: + description: Sections to display + default: repositories - # ==================================================================================== - # 📌 Starred topics - - # Enable or disable plugin - plugin_topics: - description: Display starred topics + # Compute issues and pull requests per repositories with special highlighting for maintainers and specified users + plugin_followup_indepth: + description: Indepth follow-up processing default: no - # Plugin mode - plugin_topics_mode: - description: Plugin mode - default: starred - - # Topics sorting order - plugin_topics_sort: - description: Sorting method of starred topics - default: stars - - # Number of topics to display - # Set to 0 to disable limitations - # When in "starred" mode, additional topics will be grouped into an ellipsis - plugin_topics_limit: - description: Maximum number of topics to display - default: 15 - # ==================================================================================== # 🎭 Comment reactions @@ -636,53 +641,6 @@ inputs: description: Shuffle users default: no - # ==================================================================================== - # 🎫 Gists - - # Enable or disable plugin - plugin_gists: - description: Display gists metrics - default: no - - # ==================================================================================== - # 🎟️ Follow-up of issues and pull requests - - # Enable or disable plugin - plugin_followup: - description: Display follow-up of repositories issues and pull requests - default: no - - # Sections to display - plugin_followup_sections: - description: Sections to display - default: repositories - - # Compute issues and pull requests per repositories with special highlighting for maintainers and specified users - plugin_followup_indepth: - description: Indepth follow-up processing - default: no - - # ==================================================================================== - # 👨‍💻 Lines of code changed - - # Enable or disable plugin - plugin_lines: - description: Display lines of code metrics - default: no - - # List of repositories that will be skipped - plugin_lines_skipped: - description: Repositories to skip - default: "" - - # ==================================================================================== - # 🧮 Repositories traffic - - # Enable or disable plugin - plugin_traffic: - description: Display repositories traffic metrics - default: no - # ==================================================================================== # ✨ Stargazers over last weeks @@ -717,6 +675,41 @@ inputs: description: Display projects descriptions default: no + # ==================================================================================== + # ♐ Code snippet of the day + + # Enable or disable plugin + plugin_code: + description: Display a random code snippet from recent activity + default: no + + # Maximum number of lines that a code snippet can contain + plugin_code_lines: + description: Maximum number of line that a code snippet can contain + default: 12 + + # Number of activity events to load + # A high number will consume more requests + plugin_code_load: + description: Number of events to load + default: 100 + + # Set events visibility (use this to restrict events when using a "repo" token) + plugin_code_visibility: + description: Set events visibility + default: public + + # List of repositories that will be skipped + plugin_code_skipped: + description: Repositories to skip + default: "" + + # Restrict code snippet languages + # These are guessed through linguist + plugin_code_languages: + description: Restrict code snippet languages + default: "" + # ==================================================================================== # 📰 Recent activity @@ -806,22 +799,6 @@ inputs: description: Unlocked achievements to display default: "" - # ==================================================================================== - # 💬 Discussions - - # Enable or disable plugin - plugin_discussions: - description: GitHub discussions metrics - default: no - - # ==================================================================================== - # 💭 GitHub Community Support - - # Enable or disable plugin - plugin_support: - description: GitHub Community Support metrics - default: no - # ==================================================================================== # 🎩 Notable contributions @@ -853,6 +830,43 @@ inputs: description: Indepth notable contributions processing default: no + # ==================================================================================== + # 💬 Discussions + + # Enable or disable plugin + plugin_discussions: + description: GitHub discussions metrics + default: no + + # ==================================================================================== + # 💭 GitHub Community Support + + # Enable or disable plugin + plugin_support: + description: GitHub Community Support metrics + default: no + + # ==================================================================================== + # 👨‍💻 Lines of code changed + + # Enable or disable plugin + plugin_lines: + description: Display lines of code metrics + default: no + + # List of repositories that will be skipped + plugin_lines_skipped: + description: Repositories to skip + default: "" + + # ==================================================================================== + # 🧮 Repositories traffic + + # Enable or disable plugin + plugin_traffic: + description: Display repositories traffic metrics + default: no + # ==================================================================================== # 📓 Repositories @@ -868,39 +882,25 @@ inputs: default: "" # ==================================================================================== - # ♐ Code snippet of the day + # 🎫 Gists # Enable or disable plugin - plugin_code: - description: Display a random code snippet from recent activity + plugin_gists: + description: Display gists metrics default: no - # Maximum number of lines that a code snippet can contain - plugin_code_lines: - description: Maximum number of line that a code snippet can contain - default: 12 + # ==================================================================================== + # 🙋 Introduction - # Number of activity events to load - # A high number will consume more requests - plugin_code_load: - description: Number of events to load - default: 100 + # Enable or disable plugin + plugin_introduction: + description: Display account or repository introduction + default: no - # Set events visibility (use this to restrict events when using a "repo" token) - plugin_code_visibility: - description: Set events visibility - default: public - - # List of repositories that will be skipped - plugin_code_skipped: - description: Repositories to skip - default: "" - - # Restrict code snippet languages - # These are guessed through linguist - plugin_code_languages: - description: Restrict code snippet languages - default: "" + # Display introduction section title + plugin_introduction_title: + description: Display introduction section title + default: yes # ==================================================================================== # 💕 GitHub Sponsors diff --git a/settings.example.json b/settings.example.json index 7ba477ef..f44c748b 100644 --- a/settings.example.json +++ b/settings.example.json @@ -38,23 +38,23 @@ "languages":{ "enabled": false, "//": "Display most used languages metrics" }, - "introduction":{ - "enabled": false, "//": "Display account or repository introduction" - }, - "habits":{ - "enabled": false, "//": "Display coding habits metrics" - }, - "licenses":{ - "enabled": false, "//": "Display licenses informations" - }, - "contributors":{ - "enabled": false, "//": "Display repository contributors" + "topics":{ + "enabled": false, "//": "Display starred topics" }, "stars":{ "enabled": false, "//": "Display recently starred repositories" }, - "topics":{ - "enabled": false, "//": "Display starred topics" + "licenses":{ + "enabled": false, "//": "Display licenses informations" + }, + "habits":{ + "enabled": false, "//": "Display coding habits metrics" + }, + "contributors":{ + "enabled": false, "//": "Display repository contributors" + }, + "followup":{ + "enabled": false, "//": "Display follow-up of repositories issues and pull requests" }, "reactions":{ "enabled": false, "//": "Display average issue comments reactions" @@ -62,44 +62,44 @@ "people":{ "enabled": false, "//": "Display GitHub users from various affiliations" }, - "gists":{ - "enabled": false, "//": "Display gists metrics" - }, - "followup":{ - "enabled": false, "//": "Display follow-up of repositories issues and pull requests" - }, - "lines":{ - "enabled": false, "//": "Display lines of code metrics" - }, - "traffic":{ - "enabled": false, "//": "Display repositories traffic metrics" - }, "stargazers":{ "enabled": false, "//": "Display stargazers metrics" }, "projects":{ "enabled": false, "//": "Display active projects" }, + "code":{ + "enabled": false, "//": "Display a random code snippet from recent activity" + }, "activity":{ "enabled": false, "//": "Display recent activity" }, "achievements":{ "enabled": false, "//": "Display achievements" }, + "notable":{ + "enabled": false, "//": "Display notable contributions in organizations" + }, "discussions":{ "enabled": false, "//": "GitHub discussions metrics" }, "support":{ "enabled": false, "//": "GitHub Community Support metrics" }, - "notable":{ - "enabled": false, "//": "Display notable contributions in organizations" + "lines":{ + "enabled": false, "//": "Display lines of code metrics" + }, + "traffic":{ + "enabled": false, "//": "Display repositories traffic metrics" }, "repositories":{ "enabled": false, "//": "Display chosen featured repositories" }, - "code":{ - "enabled": false, "//": "Display a random code snippet from recent activity" + "gists":{ + "enabled": false, "//": "Display gists metrics" + }, + "introduction":{ + "enabled": false, "//": "Display account or repository introduction" }, "sponsors":{ "enabled": false, "//": "Display GitHub sponsors" diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index 5e107254..96fabab6 100644 --- 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
Compact display
-
Detailed display +
Detailed display
diff --git a/source/plugins/achievements/metadata.yml b/source/plugins/achievements/metadata.yml index af22db5d..32747f5b 100644 --- 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 diff --git a/source/plugins/activity/metadata.yml b/source/plugins/activity/metadata.yml index b76ce3ad..9afe5981 100644 --- 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 diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index 389347a6..b9b52373 100644 --- 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
- -
Manga version +
For anime watchers + +
+
For manga readers
-
Favorites characters version +
Favorites characters
diff --git a/source/plugins/code/metadata.yml b/source/plugins/code/metadata.yml index b5a41eae..2688234f 100644 --- 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 diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 723ceae9..531f80e6 100644 --- 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.
- -
Raw list with names - +
By contribution types +
-
With number of contributions +
By number of contributions
diff --git a/source/plugins/contributors/metadata.yml b/source/plugins/contributors/metadata.yml index 6dc7f83e..c7a68dc5 100644 --- 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: diff --git a/source/plugins/discussions/metadata.yml b/source/plugins/discussions/metadata.yml index 7b21ca2f..56af79fe 100644 --- 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: diff --git a/source/plugins/followup/README.md b/source/plugins/followup/README.md index 5fe6998f..633cb2be 100644 --- 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
- -
Created by user version +
Indepth analysis + +
+
Created on an user's repositories + +
+
Created by an user
diff --git a/source/plugins/followup/metadata.yml b/source/plugins/followup/metadata.yml index 2c74e9b7..d2148895 100644 --- 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 diff --git a/source/plugins/gists/metadata.yml b/source/plugins/gists/metadata.yml index 777a874a..e5b36fe6 100644 --- 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: diff --git a/source/plugins/habits/README.md b/source/plugins/habits/README.md index 5de92d15..da18354f 100644 --- 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
- -
Charts version +
Recent activity charts
+
Midly interesting facts + +
diff --git a/source/plugins/habits/metadata.yml b/source/plugins/habits/metadata.yml index 42a23b43..50648be9 100644 --- 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 diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md index b9923b12..24f3b04c 100644 --- 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
-
Account version +
For an user or an organization
-
Repository version +
For a repository
diff --git a/source/plugins/introduction/metadata.yml b/source/plugins/introduction/metadata.yml index 279c0edf..7f77305d 100644 --- 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 diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md index 30795c36..c30b31b0 100644 --- 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
- -
Full year version +
Full year isometric calendar + +
+
Half year isometric calendar
diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md index a3e0a8f0..7fc68934 100644 --- 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 diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index fc686aca..0151d829 100644 --- 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
- -
With both total bytes size and percentage version - +
Indepth analysis (clone and analyze repositories) +
-
Recently used version (based on recent activity) +
Recently used (analyze recent activity events)
-
Indepth analysis (clone, analyze and extract commits) - +
Default algorithm + +
+
Default algorithm (with details) +
- -
With licenses ratio +
Permissions, limitations and conditions + +
+
Licenses overview
diff --git a/source/plugins/lines/metadata.yml b/source/plugins/lines/metadata.yml index 4eff7039..b284812e 100644 --- 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 diff --git a/source/plugins/music/README.md b/source/plugins/music/README.md index fc779c51..6e148412 100644 --- a/source/plugins/music/README.md +++ b/source/plugins/music/README.md @@ -4,10 +4,10 @@ The *music* plugin lets you display :
-
🎼 Favorite tracks version +
Random tracks from a playlist
-
Recently listened version +
Recently listened
diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md index dbaf984b..dbfb1f1b 100644 --- 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
- -
With repository name - -
Indepth analysis
+
Contributions in organizations only + +
diff --git a/source/plugins/notable/metadata.yml b/source/plugins/notable/metadata.yml index 141e5f81..9c642431 100644 --- 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: diff --git a/source/plugins/pagespeed/README.md b/source/plugins/pagespeed/README.md index 96ca747c..08b924f7 100644 --- 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
- -
Detailed version +
PageSpeed scores + +
+
PageSpeed scores with detailed report
-
With screenshot version +
PageSpeed scores with a website screenshot
diff --git a/source/plugins/people/README.md b/source/plugins/people/README.md index a93c415e..765f8411 100644 --- 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.
- -
Followed people version - +
Related to an user +
-
Special thanks version - -
-
Repository template version +
Related to a repository
diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md index 63e26556..60395329 100644 --- 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
- -
With posts descriptions and cover images version +
Latest posts + +
+
Latest posts width description and cover image
diff --git a/source/plugins/projects/metadata.yml b/source/plugins/projects/metadata.yml index c5bacbe3..18cf8e68 100644 --- 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 diff --git a/source/plugins/repositories/metadata.yml b/source/plugins/repositories/metadata.yml index 0537b4e4..7b25bfcb 100644 --- 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 diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md index 4be4ad84..e13d4a0b 100644 --- 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
- -
With GitHub sponsors introduction +
GitHub sponsors card + +
+
GitHub sponsors full introduction
diff --git a/source/plugins/stargazers/metadata.yml b/source/plugins/stargazers/metadata.yml index 49d786fc..a65debd0 100644 --- 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 diff --git a/source/plugins/stars/metadata.yml b/source/plugins/stars/metadata.yml index 9568e834..6778094f 100644 --- 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: diff --git a/source/plugins/support/metadata.yml b/source/plugins/support/metadata.yml index 6b4c17b0..2cda2052 100644 --- 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: diff --git a/source/plugins/topics/README.md b/source/plugins/topics/README.md index e59b8ab2..b3d0032f 100644 --- 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
- -
With icons instead +
With icons
+
With labels + +
diff --git a/source/plugins/topics/metadata.yml b/source/plugins/topics/metadata.yml index 6324f788..ddbe7093 100644 --- 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: diff --git a/source/plugins/traffic/metadata.yml b/source/plugins/traffic/metadata.yml index 3d74ac96..0b03ee67 100644 --- 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 diff --git a/source/plugins/tweets/README.md b/source/plugins/tweets/README.md index fd794bf6..29347a1c 100644 --- 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
- -
With tweets attachments version +
Latest tweets + +
+
Latest tweets with attachments