From 519bccae4a85023ebf16bab326e9cbedb21f0d05 Mon Sep 17 00:00:00 2001 From: Bernhard Kaindl Date: Tue, 13 Feb 2024 07:42:12 +0100 Subject: [PATCH] Add section on enabling the plugin - need to be logged in Signed-off-by: Bernhard Kaindl --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c6c5e49..d157c80 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,17 @@ Automatically see code coverage data and line annotations while browsing files o If you wish to simply use the extension, it is available as a [Firefox Add On](https://addons.mozilla.org/en-US/firefox/addon/codecov/) and a [Chrome Extension](https://chrome.google.com/webstore/detail/codecov/gedikamndpbemklijjkncpnolildpbgo). +## Enabling + +- The extension uses your Codecov logged-in session to determine what private repos you have access to. + - Please make sure to log in to Codecov. + +- Contrary to the screenshot above, the coverage may be indicated by small green and red bars to the left of the line. + +__Note to Firefox users__: Required permissions must be granted manually on [about:addons](about:addons) + +image + ## About this extension @@ -35,8 +46,6 @@ Pre-requisites: * Must use either Firefox or Google Chrome web browsers. * Must have GitHub's Global navigation update enabled -How to enable: Click your avatar at the top-right of a GitHub page and select “Feature preview”. Then select “Global navigation update” and click the Enable button located at the top right of the modal. -The extension uses your logged-in session to determine what private repos you have access to. Please make sure to log in to Codecov using your web browser to view coverage data for private repos in GitHub, ## Use with Self-Hosted and Dedicated Cloud Versions of Codecov You can use this extension against installations of Codecov and GitHub that are: