Skip to content

Commit

Permalink
nix run examples in README
Browse files Browse the repository at this point in the history
  • Loading branch information
aksiksi committed Oct 12, 2024
1 parent 7f8c853 commit 3aed8b6
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,14 @@ Install the `compose2nix` CLI via one of the following methods:

1. Run using `nix run` (**recommended**):
```
# Latest
nix run github:aksiksi/compose2nix -- -h
# Specific version
nix run github:aksiksi/compose2nix/v0.3.0 -- -h
# Specific commit
nix run github:aksiksi/compose2nix/0c38d282d6662fc902fca7ef5b33e889f9e3e59a -- -h
```
2. Install from `nixpkgs`:
```
Expand All @@ -55,11 +62,9 @@ Install the `compose2nix` CLI via one of the following methods:
```
Optionally, you can pin to a specific version:
<!-- LINT.OnChange(version) -->
```nix
compose2nix.url = "github:aksiksi/compose2nix/v0.3.0";
```
<!-- LINT.ThenChange(flake.nix:version,main.go:version) -->
You can then install the package by adding the following to your NixOS config:
```nix
Expand Down
2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
owner = "aksiksi";
# LINT.OnChange(version)
version = "0.3.1-pre";
# LINT.ThenChange(main.go:version,README.md:version)
# LINT.ThenChange(main.go:version)
in {
# Nix package
packages = forAllSystems (system:
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
const (
// LINT.OnChange(version)
appVersion = "0.3.1-pre"
// LINT.ThenChange(flake.nix:version,README.md:version)
// LINT.ThenChange(flake.nix:version)
)

// TODO(aksiksi): Investigate parsing flags into structs using the *Val functions.
Expand Down

0 comments on commit 3aed8b6

Please sign in to comment.