Update project readme with demo and description

This commit is contained in:
Nicolò Maria Mezzopera 2020-05-22 11:01:49 +02:00
parent 5fe8ca78c1
commit 96356fdd0b
No known key found for this signature in database
GPG Key ID: 4FE1B71C61DFFB1F
2 changed files with 8 additions and 4 deletions

@ -2,20 +2,24 @@
This is a tiny Chrome extension that adds a conventional comment button to GitLab file explorer comments, allowing to quickly leave a structured semantic comment during your MR reviews!
## Demo
![Demo](demo.gif)
## How to install
This is a chrome extension, recently chrome disallowed to install packed `crx` extension that are not listed on the Chrome Store, so to install this
- `git clone git@gitlab.com:conventionalcomments/conventional-comment-button.git`
- On Chrome: Menu
-- More Tools
--- Extensions
- More Tools
- Extensions
- In the Extension page: `Load unpacked` and select the cloned repository
## How to update
- `git pull`
- On Chrome: Menu
-- More Tools
--- Extensions
- More Tools
- Extensions
- In the Extension page find `conventional comments button` and hit the refresh button

BIN
demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 MiB