Skip to content

Commit

Permalink
Merge pull request #25 from x123/x123-readme-add-nix
Browse files Browse the repository at this point in the history
Add NixOS/nix section and repology badges to readme
  • Loading branch information
sts10 committed Jul 5, 2024
2 parents a9163b3 + 3ab0635 commit 0de1aff
Showing 1 changed file with 30 additions and 0 deletions.
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

0 comments on commit 0de1aff

Please sign in to comment.