Skip to content

Commit

Permalink
add warning for mv2-mv3
Browse files Browse the repository at this point in the history
  • Loading branch information
KentoNishi committed Oct 3, 2024
1 parent d314740 commit d200713
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@

## Building from Source

### ⚠️ 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.

### Development

> Note: The repo expects a Linux or Unix-like environment. If you are on Windows, use WSL.
Clone the repository:

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

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

Expand Down

0 comments on commit d200713

Please sign in to comment.