Merge pull request #96 from Preeti9764/readme-changes

docs: Add instructions for configuring Scrum Helper with custom GitHub organizations

Author: hpdang

README.md

@@ -2,14 +2,13 @@
 
 **SCRUM Helper** is a Chrome extension designed to simplify writing scrums in Google Groups for FOSSASIA projects. By adding your GitHub username, date range, and other options, it automatically fetches your PRs, Issues, and reviewed PRs via the GitHub API and pre-fills the scrum. You can then edit the scrum to fit your needs.
 
-
 ![SCRUMLOGO](docs/images/scrumhelper-png.png)
 
 ## Features
 
-- Fetches your GitHub PRs, Issues, and reviewed PRs  
-- Auto-generates scrum updates  
-- Supports Google Groups, Gmail, Yahoo, and Outlook compose windows  
+- Fetches your GitHub PRs, Issues, and reviewed PRs
+- Auto-generates scrum updates
+- Supports Google Groups, Gmail, Yahoo, and Outlook compose windows
 
 ## How to install
 
@@ -21,16 +20,19 @@
 6. Fill in your settings in the popup (GitHub username, date range, etc.)
 
 ## Usage
-### For Google Groups:  
+
+### For Google Groups:
+
 - Open Google Groups New Topic
 - Start a New Conversation
 - Refresh the page to apply the Scrum Helper settings
 - Use the pre-filled scrum and edit as needed
 
 ### For Gmail, Yahoo, and Outlook:
-- Open the Compose window.  
+
+- Open the Compose window.
 - Ensure the Scrum Helper settings are applied (follow step 6 above)
--  The extension will prefill scrum content for you to edit
+- The extension will prefill scrum content for you to edit
 
 ## Setting up the code locally
 
@@ -39,12 +41,51 @@ $ git clone https://github.com/fossasia/scrum_helper/
 $ cd scrum_helper
 $ npm install
 ```
+
 ## Screenshots
+
 ![SCRUM](/docs/images/scrum.png)
 
 ![POPUP](/docs/images/popup.png)
 
+## Using Scrum Helper with Your Own GitHub Organization
+
+Scrum Helper is not limited to the [FOSSASIA](https://github.com/fossasia) organization. You can easily configure it to fetch and generate SCRUM reports for your own GitHub organization or repositories.
+
+### Steps to Set It Up for Your Organization
+
+1. **Install the Extension**
+
+- Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
+
+2. **Update the Organization**
+
+   - Currently, the extension uses `org:fossasia` to fetch GitHub issues and PRs.
+   - To make it work with your GitHub organization:
+     - Open `scrumHelper.js` (or wherever the GitHub API URLs are defined).
+     - Replace:
+       ```js
+       +org:fossasia+
+       ```
+       with:
+       ```js
+       +org:your-org-name+
+       ```
+       **Example**
+       ![Code Snippet ](<Screenshot 2025-05-30 205822.png>)
+
+3. **Build the Extension**
+
+   - Save your changes.
+   - Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
+
+4. **Get Customized SCRUM Reports**
+   - The reports will now be generated using contributions from your organization.
+
+---
+
 ## About contributing
+
 - Follow the Issues and PRs templates as far as possible.
 - If you want to make a PR, please mention in the corresponding issue that you are working on it.
 - Before making a PR, ensure your code is properly formatted and linted: