From 66bf10ecbf3581dcce339152c95477ca4fc381fd Mon Sep 17 00:00:00 2001 From: Sebastian Estrella <2049686+sestrella@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:41:07 -0500 Subject: [PATCH] Add Templates section --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d9aa096..e40b62a 100644 --- a/README.md +++ b/README.md @@ -87,10 +87,21 @@ change](https://www.hashicorp.com/blog/hashicorp-adopts-business-source-license) the `NIXPKGS_ALLOW_UNFREE` flag is required for Terraform versions `>= 1.6.0`, `nix develop` should work out of the box for older versions. -Check out the [default template](templates/default) for a complete example of -the steps described in this section. This flake also includes a [devenv -template](templates/devenv) that demonstrates how to use `nixpkgs-terraform` -with [devenv](https://devenv.sh). +### Templates + +This flake provides the following templates: + +- [default](templates/default) - Simple nix-shell with Terraform installed via + nixpkgs-terraform. +- [devenv](templates/devenv) - Using nixpkgs-terraform with devenv. + +Run the following command to scaffold a new project using a template: + +```sh +nix flake init -t github:stackbuilders/nixpkgs-terraform#