From db09fe9d7945f9a93706ebd9f3b5ef5895f68b66 Mon Sep 17 00:00:00 2001 From: Sebastian Sauer Date: Thu, 27 Jul 2023 23:00:26 +0200 Subject: [PATCH] Update README --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 911115a..c05cd56 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,8 @@ # Conventional Comments button for gitea -This is a tiny extension that adds a conventional comment button to gitea pull request comments, allowing to quickly leave a structured semantic comment during your PR reviews! +This is a tiny extension that adds conventional comment buttons to gitea pull request comments, allowing to quickly leave a structured semantic comment during your PR reviews in [gitea](https://gitea.io)! -This extension only works with gitea versions >= 1.20. - -## Attribution - -This project was forked from https://gitlab.com/conventionalcomments/conventional-comments-button to make it usable with gitea. - -Please see LICENSE file for the original license. +For more information on conventional comments please see [the conventional comments homepage](https://conventionalcomments.org/). ## Demo @@ -48,6 +42,14 @@ Recently chrome disallowed to install packed `crx` extension that are not listed - On Firefox: enter `about:debugging#/runtime/this-firefox` into the address bar - In the Extension page find `conventional comments button` and hit the reload button -## Credits +## Supported gitea versions + +This extension only works with gitea versions >= 1.20. + +## Credits & Attribution + +This project was forked from [https://gitlab.com/conventionalcomments/conventional-comments-button](https://gitlab.com/conventionalcomments/conventional-comments-button) to make it usable with gitea. + +Please see LICENSE file for the original license. This project bundles some of the icon coming from [font-awesome](https://fontawesome.com/) icons as SVG