Skip to content

Commit 12011c7

Browse files
authored
chore: Added new readme, p=(#8671), c=no-component
1 parent 280f0ca commit 12011c7

File tree

1 file changed

+6
-111
lines changed

1 file changed

+6
-111
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 6 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![Crowdin](https://badges.crowdin.net/zen-browser/localized.svg)](https://crowdin.com/project/zen-browser)
88
[![Zen Release builds](https://github.com/zen-browser/desktop/actions/workflows/build.yml/badge.svg?branch=stable)](https://github.com/zen-browser/desktop/actions/workflows/build.yml)
99

10-
✨ Experience tranquillity while browsing the internet with Zen! Our mission is to give you a balance between speed, privacy and productivity!
10+
Zen is a firefox-based browser with the aim of pushing your productivity to a new level!
1111

1212
<div flex="true">
1313
<a href="https://zen-browser.app/download">
@@ -27,118 +27,13 @@
2727
</a>
2828
</div>
2929

30-
## πŸ–₯️ Compatibility
30+
### Firefox Versions
3131

32-
Zen is currently built using Firefox version `139.0.1`! πŸš€
32+
- [`Release`](https://zen-browser.app/download) - Is currently built using Firefox version `139.0.1`! πŸš€
33+
- [`Twilight`](https://zen-browser.app/download?twilight) - Is currently built using Firefox version `RC 139.0.1`!
3334

34-
- [`Zen Twilight`](https://zen-browser.app/download?twilight) - Is currently built using Firefox version `RC 139.0.1`!
35-
- Check out the latest [release notes](https://zen-browser.app/release-notes)!
36-
- Part of our mission is to keep Zen up-to-date with the latest version of Firefox, so you can enjoy the latest features and security updates!
35+
### Contributing
3736

38-
## 🀝 Contribution
37+
If you'd like to report a bug, please do so on our [GitHub Issues page](https://github.com/zen-browser/desktop/issues/) and for feature requests, you can use [Github Discussions](https://github.com/zen-browser/desktop/discussions).
3938

4039
Zen is an open-source project, and we welcome contributions from the community! Please take a look at the [contribution guidelines](./docs/contribute.md) before getting started!
41-
42-
### Issue metrics
43-
44-
We keep track of how many issues are closed at the end of the month in [docs/issue-metrics](./docs/issue-metrics). We use this to keep track of our issues and see our progress! πŸ“ˆ
45-
46-
### Versioning
47-
48-
Zen uses [Semantic Versioning](https://semver.org/), meaning versions are displayed as `a.b.cd` where:
49-
50-
- `a` is the major version
51-
- `b` is the minor version
52-
- `c` is the branch prefix
53-
- `d` is the patch version
54-
55-
### Branches
56-
57-
Zen is divided into 2 main branches. We use `dev` for development and `stable` for stable releases. The `dev` branch is where all the new features are added and where `twilight` builds are generated. The `stable` branch is where the stable releases are generated.
58-
59-
We divide into 2 branches in case there's any really important security update (for example) that needs to be released before the next stable release. This allows us to do patches without releasing unstable versions to the public.
60-
61-
## πŸ“₯ Installation
62-
63-
### Supported Operating Systems
64-
65-
Zen is available for Linux, macOS, and Windows. You can download the latest version from the official website at [zen-browser.app](https://zen-browser.app/download), or from the [GitHub Releases](https://github.com/zen-browser/desktop/releases) page.
66-
67-
If you don't see your OS listed below, that's because we already have it in our [downloads page](https://zen-browser.app/download)! Make sure to check it out!
68-
69-
#### Windows
70-
71-
##### Winget
72-
73-
```ps
74-
winget install --id Zen-Team.Zen-Browser
75-
```
76-
77-
#### macOS
78-
79-
- Requires macOS 10.15 or later
80-
- Available for ARM and Intel architectures
81-
82-
You can also install Zen using Homebrew:
83-
84-
```
85-
brew install zen-browser
86-
```
87-
88-
#### Linux
89-
90-
##### Arch-based distributions
91-
92-
```sh
93-
yay -S zen-browser-bin
94-
```
95-
96-
##### Other Linux distributions (Tarball or AppImage)
97-
98-
- `Tarball` install:
99-
100-
```sh
101-
bash <(curl -s https://updates.zen-browser.app/install.sh)
102-
```
103-
104-
- `AppImage` install:
105-
106-
```sh
107-
bash <(curl https://updates.zen-browser.app/appimage.sh)
108-
```
109-
110-
> AppImage install requires `zsync` for the Update feature
111-
112-
- Again, if you don't see your OS listed above, that's because we already have it in our [downloads page](https://zen-browser.app/download)! πŸ”„
113-
114-
To upgrade the browser to a newer version, use the embedded update functionality in `About Zen`.
115-
116-
## πŸ‘¨β€πŸ’» Development and Contributing
117-
118-
Some components used by @zen-browser as an attempt to make Firefox forks a better place, and for other to enjoy the beauty of OSS. You can find them [here](https://github.com/zen-browser/desktop/tree/dev/src/zen).
119-
120-
#### `Run Locally`
121-
122-
In order to download and run Zen locally, please follow [these instructions](https://docs.zen-browser.app/guides/building).
123-
124-
#### `Special Thanks`
125-
126-
Special thanks to... EVERYONE πŸŽ‰! Checkout the team and contributors page [here](https://zen-browser.app/about)
127-
128-
#### `Third Party Code`
129-
130-
Zen couldn't be in its current state without the help of these amazing projects! πŸ™
131-
132-
- Zen's default preferences are based on [BetterFox](https://github.com/yokoffing/Betterfox)
133-
- Gradient image extracted from [Arc Palette](https://github.com/neurokitti/Arc_Palette)
134-
- `icons.css` has been modified from [Edge Firefox](https://github.com/bmFtZQ/edge-frfox) (MIT licensed file).
135-
136-
### πŸ–₯️ Comparison with other browsers
137-
138-
Thanks everyone for making Zen stand out among these giants!
139-
140-
[![Star History Chart](https://api.star-history.com/svg?repos=zen-browser/desktop,chromium/chromium,brave/brave-browser&type=Date)](https://star-history.com/#zen-browser/desktop&chromium/chromium&brave/brave-browser&Date)
141-
142-
## πŸ“„ License
143-
144-
Zen browser is under the [MPL 2.0 LICENSE](./LICENSE). All the code is open-source and free to use! Attribution is appreciated but not required.

0 commit comments

Comments
Β (0)