Skip to content

Commit

Permalink
doc: collapse installation sections
Browse files Browse the repository at this point in the history
as suggested in #133
  • Loading branch information
ryantm committed Jan 29, 2023
1 parent 6d3a415 commit c695ebc
Showing 1 changed file with 28 additions and 15 deletions.
43 changes: 28 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,10 @@
* [Problem and solution](#problem-and-solution)
* [Features](#features)
* [Installation](#installation)
* [niv](#install-via-niv) (Current recommendation)
* [module](#install-module-via-niv)
* [CLI](#install-cli-via-niv)
* [niv](#install-via-niv)
* [nix-channel](#install-via-nix-channel)
* [module](#install-module-via-nix-channel)
* [CLI](#install-cli-via-nix-channel)
* [fetchTarball](#install-via-fetchtarball)
* [module](#install-module-via-fetchtarball)
* [CLI](#install-cli-via-fetchTarball)
* [flakes](#install-via-flakes)
* [module](#install-module-via-flakes)
* [CLI](#install-cli-via-flakes)
* [Tutorial](#tutorial)
* [Reference](#reference)
* [`age` module reference](#age-module-reference)
Expand Down Expand Up @@ -49,15 +41,13 @@ All files in the Nix store are readable by any system user, so it is not a suita

## Installation

Choose one of the following methods:

* [niv](#install-via-niv)
* [nix-channel](#install-via-nix-channel)
* [fetchTarball](#install-via-fetchTarball)
* [flakes](#install-via-flakes)
<details>
<summary>

### Install via [niv](https:/nmattia/niv)

</summary>

First add it to niv:

```ShellSession
Expand All @@ -84,8 +74,15 @@ To install the `agenix` binary:
}
```

</details>

<details>
<summary>

### Install via nix-channel

</summary>

As root run:

```ShellSession
Expand Down Expand Up @@ -113,8 +110,15 @@ To install the `agenix` binary:
}
```

</details>

<details>
<summary>

### Install via fetchTarball

</summary>

#### Install module via fetchTarball

Add the following to your configuration.nix:
Expand Down Expand Up @@ -152,8 +156,15 @@ To install the `agenix` binary:
}
```

</details>

<details>
<summary>

### Install via Flakes

</summary>

#### Install module via Flakes

```nix
Expand Down Expand Up @@ -192,6 +203,8 @@ but, if you want to (change the system based on your system):
}
```

</details>

## Tutorial

1. The system you want to deploy secrets to should already exist and
Expand Down

0 comments on commit c695ebc

Please sign in to comment.