From 20bbd78a7b4d8f293a321dc94bedbe36d9a83af5 Mon Sep 17 00:00:00 2001 From: XtoMHA96 Date: Mon, 9 Oct 2023 10:19:13 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 51 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 308d823..469862f 100644 --- a/README.md +++ b/README.md @@ -3,42 +3,77 @@

This repository is used for creating dynamic browser sources related to timers, ideal for use in OBS (Open Broadcaster Software).

-GitHub package.json version -GitHub last commit (by committer) -GitHub release (latest by SemVer including pre-releases) +

+ +GitHub package.json version + + +GitHub last commit (by committer) + +

+

+ +GitHub watchers + + +GitHub forks + + +GitHub Repo stars + +


-GitHub watchers -GitHub forks -GitHub Repo stars +

+ +GitHub tag (with filter) + + +GitHub all releases + +



-Made with NodeJS -Made with HTML -Made with CSS -
-NodeJS version -npm version +

+ +Made with NodeJS + + +Made with HTML + + +Made with CSS + +

+

+ +NodeJS version + + +npm version + +

-## Collaborators +## :busts_in_silhouette: Collaborators

XtoManuel

___ -### Description +### :clipboard: Description This code allows you to create timers, countdowns, countdowns to a specific time, and display the current time. Each of these features comes with a browser source for OBS, which you can preview in your browser and configure to your needs. One of the additional functions of this repository is the ability to modify the timers through events sent from a StreamDeck or a similar tool using websockets. -### About the Code +### :keyboard: About the Code I have chosen to publish this code to make it accessible for free, openly, and as open-source. These codes I have developed have helped me continue learning, and since it doesn't entail any financial cost for me, there will also be no paid features created. It will be open to anyone who wants to use it and collaborate in improving the code. The codes have been created with my current knowledge and may contain errors or areas that need improvement. I have worked on this code in my free time. -### Documentation +### :book: Documentation ~~WIKI~~ (In construction) From 2961c98242f079fe1d3011b91abb135451fd8638 Mon Sep 17 00:00:00 2001 From: XtoManuel Date: Mon, 9 Oct 2023 10:21:53 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 469862f..eecf19a 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,7 @@

-GitHub tag (with filter) +GitHub tag (with filter) GitHub all releases From e5c49f563a68313976ca75411857fc6c06317cdf Mon Sep 17 00:00:00 2001 From: XtoManuel Date: Mon, 9 Oct 2023 10:26:49 +0100 Subject: [PATCH 3/4] Update README.md The preview in VS Code is different from the one shown in GitHub --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index eecf19a..a82e588 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,13 @@

This repository is used for creating dynamic browser sources related to timers, ideal for use in OBS (Open Broadcaster Software).

-

GitHub package.json version GitHub last commit (by committer) -

-

+
GitHub watchers @@ -21,19 +19,17 @@ GitHub Repo stars -


-

+
GitHub tag (with filter) GitHub all releases -



-

+
Made with NodeJS @@ -43,15 +39,13 @@ Made with CSS -

-

+
NodeJS version npm version -

## :busts_in_silhouette: Collaborators From 8d792f0ca34801ba98a1aaacaedb34b5262552b0 Mon Sep 17 00:00:00 2001 From: XtoMHA96 Date: Mon, 9 Oct 2023 12:27:17 +0100 Subject: [PATCH 4/4] Add issue templates and improve README.md - Creation of forms for issues, suggestions and translations. - Improved README.md --- .../{bug_report.yml => bug_report.yaml} | 6 ++- .github/ISSUE_TEMPLATE/feature_request.yaml | 24 +++++++++++ .github/ISSUE_TEMPLATE/translate.yaml | 42 +++++++++++++++++++ 3 files changed, 70 insertions(+), 2 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.yml => bug_report.yaml} (92%) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/translate.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yaml similarity index 92% rename from .github/ISSUE_TEMPLATE/bug_report.yml rename to .github/ISSUE_TEMPLATE/bug_report.yaml index b15277a..bb193b9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,6 +1,6 @@ name: Bug Report description: File a bug report -title: "[BUG]: your bug report title" +title: "[BUG] Your bug report title" labels: "maybe: bug" body: - type: textarea @@ -49,7 +49,9 @@ body: attributes: label: Steps until the issue appears description: "[optional] You can add the steps taken to be able to reproduce your problem." - placeholder: "1. Description of step 1 ...\n2. Description of step 2 ...\n..." + placeholder: "1. Description of step 1 ...\n + 2. Description of step 2 ...\n + ..." - type: textarea id: expected-result attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..323602b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,24 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[SUGGESTION] Your feature request title" +labels: "suggestion" +body: + - type: textarea + id: description + attributes: + label: Description. Please elaborate. + description: A clear and concise description of what new functions to add or improve. + validations: + required: true + - type: textarea + id: benefit + attributes: + label: Who will this benefit? + description: Does this feature apply to a great portion of users? + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: "[optional] You may provide additional context or screenshots for us to better understand the need of the feature." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/translate.yaml b/.github/ISSUE_TEMPLATE/translate.yaml new file mode 100644 index 0000000..95c998c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/translate.yaml @@ -0,0 +1,42 @@ +name: Translates +description: Improve code translation +title: "[TRANSLATE] Your bug report title" +labels: "translate" +body: + - type: input + id: language + attributes: + label: Language + #description: + placeholder: eg. english + validations: + required: true + - type: input + id: lang-code + attributes: + label: Language code + description: "" + placeholder: eg. en + - type: textarea + id: translate + attributes: + label: Translate YAML + description: "You can send the YAML file already translated or write it in this section.\n\n + [WARNING] If you want to directly write the translation in this section, the code must start with ```yaml and end with ```. You can use the "Preview" tab to see if the code has been written correctly." + placeholder: "```md\n + home:\n + \tclose: Close the window and stop the code\n + \tcronoTitle: CLOCKS\n + \tcdownTitle: TIMERS\n + \tcdowntimeTitle: TIME UNTIL...\n + \ttwitchextTitle: EXTENSIBLE TWITCH\n + \ttimeTitle: CURRENT TIME\n + \tnotycopycrono: URL copied to clipboard\n + crono:\n + \tbuttons:\n + \t\tstart: Start\n + \t\tpause: Pause\n + \t\treset: Reset\n + ```" + validations: + require: true \ No newline at end of file