Skip to content

Commit

Permalink
doc: Add installation section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
juanibiapina committed May 22, 2024
1 parent 3757cf4 commit c3f252d
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,42 @@ a directory (and subdirectories) of scripts.
- **Completions:** Supports auto completion of subcommands.
- **Cross-platform:** Works on Linux and macOS.

## Installation

### Homebrew

```sh
brew install juanibiapina/tap/sub
```

### Nix with Flakes

Add sub to your flake inputs:

```nix
{
inputs = {
sub = {
url = "github:juanibiapina/sub";
inputs.nixpkgs.follows = "nixpkgs"; # Optional
};
};
# ...
}
```

Then add it to your packages:

```nix
{
environment.systemPackages = with pkgs; [
inputs.sub.packages."${pkgs.system}".sub
# ...
];
}
```

## Overview

`sub` is meant to be used as the entry point for a CLI. Given the following
Expand Down

0 comments on commit c3f252d

Please sign in to comment.