Add Step-by-step installation guide for developers

wanhose 2024-10-14 12:51:12 +00:00
parent eb7afcf68f
commit a06bed7009

@ -0,0 +1,35 @@
## Step 1
Start by cloning the repository to your local machine using the command `git clone <repository-url>` or downloading it from the assets section of a release.
## Step 2
Navigate to the cloned repository's directory with `cd <repository-name>`.
## Step 3
Open your browser's extensions page:
- For Chrome, navigate to [chrome://extensions](chrome://extensions)
- For Firefox, navigate to [about:addons](about:addons)
- For Edge, navigate to [edge://extensions](edge://extensions)
## Step 4
Enable **Developer mode** (usually a toggle switch in the top right corner of the extensions page).
## Step 5
Click on the **Load unpacked** button.
## Step 6
A file dialog will open. Navigate to and select the `packages/browser-extension/src` folder from the cloned repository.
## Step 7
Congratulations! You've successfully loaded the development build of this extension.
To ensure you're using the latest version of the extension, it's important to regularly pull the latest changes from the repository. You can do this by navigating to the repository's directory in your terminal and running the command `git pull`. This will fetch and download the latest changes from the remote repository and merge them into your local repository.
In some cases, after pulling the latest changes and rebuilding the extension, your browser may not immediately reflect the updates. This is because browsers typically cache extensions for performance reasons. To manually update the extension, navigate to your browser's extensions page. Look for a button or option to "Update" or "Reload" the extension. This forces the browser to reload the extension, ensuring it's running the latest version. Remember, this process may vary slightly depending on the browser you're using. Always refer to your browser's specific instructions for managing extensions.