diff --git a/README.md b/README.md index a91c33e..1f68585 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # Scrum Helper **Scrum Helper** is a Chrome extension that simplifies writing development reports by auto-filling content based on your Git activity. Just enter your GitHub username, select a date range, and choose your preferences, the extension automatically fetches your commits, pull requests, issues, and code reviews via the GitHub API and generates a pre-filled report that you can edit as needed. While currently focused on Git-based workflows, Scrum Helper is designed to expand to other platforms in the future. @@ -17,26 +16,34 @@ ### For Chrome: 1. Clone this repository to your local machine. -2. Go to `chrome://extensions` on your chrome browser. +2. Go to `chrome://extensions` on your Chrome browser. 3. Enable Developer Mode (toggle in the top-right) if not already. -4. Click Load unpacked and select the `src` folder inside the cloned repo -5. Click the Scrum Helper icon on your browser toolbar +4. Click Load unpacked and select the `src` folder inside the cloned repo. +5. Click the Scrum Helper icon on your browser toolbar. 6. Fill in your settings in the popup (GitHub username, date range, etc.) - +- Scrum Helper uses the `chrome.*` API namespace, which is supported in Firefox for most WebExtension APIs. Firefox provides compatibility for these APIs, but some advanced or Chrome-only APIs may not be available. For most users, all major features will work as expected in Firefox. +- If you encounter issues, consult the [MDN WebExtension compatibility guide](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Chrome_incompatibilities). +- For advanced cross-browser compatibility, you may use the [webextension-polyfill](https://github.com/mozilla/webextension-polyfill), but it is not required for standard usage of Scrum Helper. ## Usage @@ -56,27 +63,29 @@ ### New Features 1. **Standalone Popup Interface** + - Generate reports directly from the extension popup - Live preview of the report before sending - Rich text formatting with clickable links - Copy report to clipboard with proper formatting -2. **Advanced Repository Filtering** - * Select specific repositories to include in your report for a more focused summary. - * Easily search and manage your repository list directly within the popup. - * *Requires a GitHub token to fetch your repositories.* +2. **Advanced Repository Filtering** + + - Select specific repositories to include in your report for a more focused summary. + - Easily search and manage your repository list directly within the popup. + - _Requires a GitHub token to fetch your repositories._ -3. **Include Commits on Existing PRs** - * Option to include recent commits made to pull requests that were opened *before* the selected date range. - * Provides a more detailed and accurate view of your work on long-running PRs. - * *Requires a GitHub token.* +3. **Include Commits on Existing PRs** + - Option to include recent commits made to pull requests that were opened _before_ the selected date range. + - Provides a more detailed and accurate view of your work on long-running PRs. + - _Requires a GitHub token._ ### Usage Standalone + - Click on `GENERATE` button to generate the scrum preview. - Edit it in the window. - Copy the rich HTML using the `COPY` button. - ## Screenshots ![SCRUM](docs/images/scrum.png) @@ -99,14 +108,12 @@ $ npm install 1. **Install the Extension** -* For Chrome: Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/). +- For Chrome: Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/). - 2. **Build the Extension** - * For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension). + - For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension). - 3. **How to Obtain a GitHub Personal Access Token** - To use Scrum Helper with authenticated requests (for higher rate limits and private repositories), you need a GitHub personal access token. @@ -114,30 +121,33 @@ $ npm install #### Steps to Generate a Token 1. **Go to GitHub Developer Settings:** - Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account. + Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account. + + 2. **Choose Token Type:** + + - Select **"Personal access tokens (classic)"**. - 2. **Choose Token Type:** - - Select **"Personal access tokens (classic)"**. + 3. **Generate a New Token:** - 3. **Generate a New Token:** - - Click **"Generate new token"**. - - Give your token a descriptive name (e.g., "Scrum Helper Extension"). - - Set an expiration date if desired. + - Click **"Generate new token"**. + - Give your token a descriptive name (e.g., "Scrum Helper Extension"). + - Set an expiration date if desired. - 4. **Create and Copy the Token:** - - Click **"Generate token"** at the bottom. - - **Copy the token** and save it securely. You will not be able to see it again! + 4. **Create and Copy the Token:** - 5. **Paste the Token in Scrum Helper:** - - Open the Scrum Helper extension popup. - - Paste your token into the "GitHub Token" field. + - Click **"Generate token"** at the bottom. + - **Copy the token** and save it securely. You will not be able to see it again! + + 5. **Paste the Token in Scrum Helper:** + + - Open the Scrum Helper extension popup. + - Paste your token into the "GitHub Token" field. > **Keep your token secret!** Never share it or commit it to public repositories. **Why use a token?** GitHub tokens allow the extension to make authenticated requests, increasing your API rate limit and enabling access to private repositories if you grant those permissions. - ## About contributing - Follow the Issues and PRs templates as far as possible.