Skip to content

Commit

Permalink
refactor(Readme): More informative Install section
Browse files Browse the repository at this point in the history
  • Loading branch information
AChep authored Nov 14, 2024
1 parent e531949 commit d92a16d
Showing 1 changed file with 37 additions and 15 deletions.
52 changes: 37 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,10 @@ _Can be used with any Bitwarden® installation. This product is not associated w
Keyguard is written using Kotlin Multiplatform + Compose Multiplatform and largely dependent on the JVM libraries. Keyguard is focusing to be **Android** first, other platforms might have some features missing.

- [Android](#android);
- [Linux](#linux) _(via Flatpak)_;
- [Linux](#linux);
- [Windows](#windows);
- [macOS](#macos).

You can find artifacts for your platform on the [releases](https://github.com/AChep/keyguard-app/releases) page.


#### Looks

| | | |
Expand All @@ -65,18 +62,43 @@ You can find artifacts for your platform on the [releases](https://github.com/AC

The app is available in multiple package repositories:

#### Android
### Android
You can find the `.apk` binary on the [releases page](https://github.com/AChep/keyguard-app/releases/latest).
- [Play Store](https://play.google.com/store/apps/details?id=com.artemchep.keyguard);
- [F-Droid](https://gh.artemchep.com/keyguard-repo-fdroid/repo) (custom F-Droid repository).

#### Linux
- [AUR](https://aur.archlinux.org/packages/keyguard) (_unofficial package_).

#### macOS
- [brew](https://formulae.brew.sh/cask/keyguard).

#### Windows
- [scoop](https://github.com/AChep/keyguard-repo-scoop) (custom [Scoop](https://scoop.sh/) bucket).
- [F-Droid custom repo](https://gh.artemchep.com/keyguard-repo-fdroid/repo).

### Linux
You can find the `.flatpak` binary on the [releases page](https://github.com/AChep/keyguard-app/releases/latest).

##### [AUR](https://aur.archlinux.org/) Keyguard [package](https://aur.archlinux.org/packages/keyguard)
> [!NOTE]
> The package is maintained by a volunteer
```sh
yay -S keyguard
```

### macOS
You can find the `.dmg` binaries for Apple and Intel processors on the [releases page](https://github.com/AChep/keyguard-app/releases/latest).

##### [Homebrew](https://brew.sh/) Keyguard [cask](https://formulae.brew.sh/cask/keyguard)
```sh
brew install --cask keyguard
```

### Windows
You can find the `.msi` binary on the [releases page](https://github.com/AChep/keyguard-app/releases/latest).

##### [Scoop](https://scoop.sh/) Keyguard [bucket](https://github.com/AChep/keyguard-repo-scoop)
```pwsh
scoop bucket add keyguard https://github.com/AChep/keyguard-repo-scoop
scoop install keyguard/keyguard
```

##### [Scoop](https://scoop.sh/) Extras [bucket](https://github.com/ScoopInstaller/Extras)
```pwsh
scoop bucket add extras
scoop install keyguard
```

## License

Expand Down

0 comments on commit d92a16d

Please sign in to comment.