diff --git a/.github/README.md b/.github/README.md index f3e3518..b1f10a0 100644 --- a/.github/README.md +++ b/.github/README.md @@ -8,16 +8,21 @@ This is a flake for the Zen browser. - Linux support - Available for x86_64 and aarch64 +- Both **twilight** and **beta** versions are available - Automatic updated Flake via GitHub Actions -- Both **twilight** and **beta** versions are distributed - Integrated browser update checks are disabled +- The default twilight version is reliable and reproducible ## Installation > [!CAUTION] -> The **Twilight** version is not really that reproducible over time while trying to download the src again due the way how the official Zen browser repository is managing -> their releases, **a new release replaces the previous one and so on**. When using this version you should compromise yourself to update the flake with `nix flake update zen-browser`. -> Or wait for a contribution that mitigates that behavior in that specific version of the browser. +> The **twilight** package is not the official from [zen-browser/desktop](https://github.com/zen-browser/desktop). As you can +> check in their [releases page](https://github.com/zen-browser/desktop/releases), there is only one Twilight version of the browser, +> that's because there's only one tag available for that browser version, it means that every release replace the other, deleting the +> artifacts that we referenced once and normally this happens everyday so the package we aim to create won't achieve the goal to be really +> reproducible, for that reason we created a workaround to create releases and copy the artifacts from their repository in order to keep +> alive indefinitely. If you don't trust about this method we're using or that the artifacts won't be infected will malware by the +> repository owner or something else(I don't know, anything!), you can use the **twilight-official** package or simply keep yourself with **beta**. Just add it to your NixOS `flake.nix` or home-manager: @@ -36,7 +41,8 @@ To integrate `Zen Browser` to your NixOS/Home Manager configuration, add the fol # Only 'x86_64-linux' and 'aarch64-linux' are supported inputs.zen-browser.packages."${system}".default # beta inputs.zen-browser.packages."${system}".beta -inputs.zen-browser.packages."${system}".twilight +inputs.zen-browser.packages."${system}".twilight # artifacts are downloaded from this repository to guarantee reproducibility +inputs.zen-browser.packages."${system}".twilight-official # artifacts are downloaded from the official Zen repository ``` Afterwards you can just build your configuration and start the `Zen Browser`