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.

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

Add NixOS/nix section and repology badges to readme #25

Merged
merged 2 commits into from
Jul 5, 2024
Merged
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions readme.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
[![Crates.io](https://img.shields.io/crates/v/phraze?link=https%3A%2F%2Fcrates.io%2Fcrates%2Fphraze)](https://crates.io/crates/phraze)
[![](https://deps.rs/repo/github/sts10/phraze/status.svg)](https://deps.rs/repo/github/sts10/phraze)
[![Crates.io](https://img.shields.io/crates/l/phraze)](./LICENSE.txt)
[![Packaging status](https://repology.org/badge/tiny-repos/phraze.svg)](https://repology.org/project/phraze/versions)

Generate random passphrases.

Expand All @@ -28,6 +29,35 @@ curse-argues-valves-unfair-punk-ritual-inlet

Uninstall Phraze by running `cargo uninstall phraze`.

### NixOS/nix

[![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/phraze.svg)](https://repology.org/project/phraze/versions)

Phraze is available within `nixpkgs`, and can be used:

- System-wide on a NixOS system using `environment.systemPackages =
[pkgs.phraze]`
- Per-user using home-manager `home.packages = [pkgs.phraze]`
- One-off with `nix run`

```shell
# Run one-shot via nix
$ nix run nixpkgs#phraze -- -S -s _b -t
Commuter=Scripts_Motorway9Battle&Results,Trouble-Policy@Tools
```

- Via a temporary nix shell without installing.

```shell
# Drop into a nix shell with phraze available
$ nix shell nixpkgs#phraze
$ which phraze
/nix/store/i1car5jf8w6vxglfi2gdrzsbzmi2vrrh-phraze-0.3.11/bin/phraze
$ phraze -S -s _b -t
Meditation)Skin0Invalid!Donations6Targeted(Housed8Tossed#Synagogue
$ exit
```

### Latest release
Alternatively, you can get binaries from [the GitHub releases page](https://github.com/sts10/phraze/releases).

Expand Down