From 763cf0ee1e350d5d41e857756f90034636a79996 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 2 Oct 2019 07:54:25 -0700 Subject: [PATCH] README: Link to the version selection guide --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7b7ac71..d807a42 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ both human- and machine-friendly, for use with command-line tools. Although intended to be generally useful, it is primarily targeted towards devops tools, servers, etc. +> **NOTE:** This is major version 2 of HCL, whose Go API is incompatible with +> major version 1. Both versions are available for selection in Go Modules +> projects. HCL 2 _cannot_ be imported from Go projects that are not using Go Modules. For more information, see +> [our version selection guide](https://github.com/golang/go/wiki/Version-Selection). + HCL has both a _native syntax_, intended to be pleasant to read and write for humans, and a JSON-based variant that is easier for machines to generate and parse.