BTHLABS-66: Prepping for public release: Take two

This commit is contained in:
2025-11-19 20:28:31 +01:00
parent 38785ccf92
commit 22061486a8
6 changed files with 96 additions and 24 deletions

View File

@@ -1,3 +1,36 @@
# HotPocket by BTHLabs
This repository contains the _HotPocket Extension_ project.
## Development environment setup
### Requirements
* macOS (18 or newer) or modern Linux (including WSL2).
* nodejs v22.14 or later.
* yarnpkg v1.22.22 or newer.
### Setup
1. `yarn install`
## Building browser-specific extensions
To build a browser-specific extension, use the following command:
```
$ yarn build:<target>
```
Where `<target>` is the name of the browser. The currently supported targets
are: `safari`, `firefox`, `chrome`. The build result will be placed in
`dist/<target>-production` for Firefox and Chrome extensions. Safari
extension will be built in the `apple` service tree.
## Author
_HotPocket_ is developed by [BTHLabs](https://www.bthlabs.pl/).
## License
_HotPocket_ is licensed under the Apache 2.0 License.