Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #109

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,21 @@ Since Hazel routes all the traffic for downloading the actual application files

As an example, check out the [latest Now Desktop release](https://api.github.com/repos/zeit/now-desktop/releases/latest) and search for `mac.zip`. You'll find a release containing a sub property named `download_count` with the amount of downloads as its value.

## Release Files Naming And Extension

We find and cache releases for each platform by the file name and extension. it may be obvious but can save quite some times for those who just getting started.

As you can see in [platform.js](https://github.com/vercel/hazel/blob/master/lib/platform.js) and [aliases.js](https://github.com/vercel/hazel/blob/master/lib/aliases.js), for each OS, the extensions are expected as below:

| OS | :platform | .Extension |
| ----------- | ----------- | ----------- |
| Windows | win32, windows, win | .exe
| macOS | dmg | .dmg
| macOS | darwin | .zip (only if the file name contains "mac" or "darwin")
| Linux with RPM package manager | fedora | .rpm
| Linux with DEB package manager | debian | .deb
| Linux | appimage | .AppImage

## Routes

### /
Expand Down