Skip to content

Commit

Permalink
Update docs to reflect branch name changes
Browse files Browse the repository at this point in the history
  • Loading branch information
arkon committed Jan 12, 2025
1 parent 25173ec commit 3f006a7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ name: "CodeQL"

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ master ]
branches: [ main ]

jobs:
analyze:
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@

### ⚠️ WARNING ⚠️

Due to unreliable Manifest v3 feature support in Firefox, we maintain both MV2 and MV3 versions of HyperChat in parallel. The MV2 variant sits in the `master` branch, while the MV3 variant sits on the `mv3` branch. When contributing, please ensure that you check out to the `master` branch to implement the features in MV2 first. Once the feature is stable, please open a separate PR to the `mv3` branch to port the feature to MV3.
For legacy reasons, we have a `mv2` branch for Firefox support while the `main` branch houses the main MV3 version.

TODO: we need to confirm whether the MV2 variant is still required for modern versions of Firefox.

### Development

Expand All @@ -29,7 +31,6 @@ Open the repository and npm install:

```bash
cd hyperchat
git checkout master # switch to master for MV2 first!
npm install # install dependencies
```

Expand Down

0 comments on commit 3f006a7

Please sign in to comment.