Skip to content

Commit eb54082

Browse files
jpluscplusmmvdan
authored andcommitted
README: minor updates
- Include mention of TOML and Protobuf - Bump version in example build command to match latest release - Various list/link/prose improvements Signed-off-by: Jonathan Matthews <[email protected]> Change-Id: I8c9eb16ea2d599dcd59307f67a9b1b7b1e5d88d2 Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1216677 TryBot-Result: CUEcueckoo <[email protected]> Reviewed-by: Daniel Martí <[email protected]>
1 parent 6fd9f7d commit eb54082

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ CUE makes it easy to validate data, write schemas,
2626
and ensure configurations align with policies.
2727

2828
CUE works with a wide range of tools and formats that you're already using
29-
such as Go, JSON, YAML, OpenAPI, and JSON Schema.
29+
such as Go, JSON, YAML, TOML, OpenAPI, Protobuf, and JSON Schema.
3030

3131
For more information and documentation, including __tutorials and guides__, see [cuelang.org](https://cuelang.org).
3232

3333
### Download and Install
3434

35-
The full range of installation methods for the `cue` command are listed on the
36-
[cuelang.org site](https://cuelang.org/docs/introduction/installation/),
35+
The full range of installation methods for the `cue` command are listed on
36+
[cuelang.org](https://cuelang.org/docs/introduction/installation/),
3737
including the official container image suitable for use with Docker.
3838
Here are two common ways to install the command:
3939

@@ -51,21 +51,28 @@ You can also clone the repository and build it directly via `go install ./cmd/cu
5151
Note that local builds [lack version information](https://go.dev/issue/50603),
5252
so you should inject the version string when building a release, such as:
5353

54-
git switch -d v0.11.0
55-
go install -ldflags='-X cuelang.org/go/cmd/cue/cmd.version=v0.11.0' ./cmd/cue
54+
git switch -d v0.13.1
55+
go install -ldflags='-X cuelang.org/go/cmd/cue/cmd.version=v0.13.1' ./cmd/cue
5656

5757
### Learning CUE
5858

59-
The fastest way to learn the basics is to follow the [tour on the website](https://cuelang.org/docs/tour/).
59+
The fastest way to learn the basics is to follow [the language tour](https://cuelang.org/docs/tour/) on the website.
6060

61-
More documentation including various tutorials can be found [on the website](https://cuelang.org/docs/).
61+
The [cuelang.org](https://cuelang.org) website also contains
62+
[more documentation](https://cuelang.org/docs/), including
63+
[tutorials](https://cuelang.org/docs/tutorial/),
64+
[how-to guides](https://cuelang.org/docs/howto/),
65+
[concept guides](https://cuelang.org/docs/concept/), and
66+
[references](https://cuelang.org/docs/reference/).
6267

63-
### References
68+
### Popular references
6469

65-
- [Language Specification](https://cuelang.org/docs/reference/spec/): the official CUE Language specification
66-
- [Go API](https://pkg.go.dev/cuelang.org/go/cue): the Go API on pkg.go.dev
67-
- [Builtin packages](https://pkg.go.dev/cuelang.org/go/pkg): builtin functions available from CUE programs
68-
- [`cue` CLI](https://cuelang.org/docs/reference/cli/): the `cue` command line interface
70+
- The official [CUE Language Specification](https://cuelang.org/docs/reference/spec/)
71+
- The CUE [Go API](https://pkg.go.dev/cuelang.org/go) on pkg.go.dev
72+
- [Builtin packages and functions](https://pkg.go.dev/cuelang.org/go/pkg)
73+
available from CUE programs
74+
- [The `cue` command](https://cuelang.org/docs/reference/command/),
75+
a versatile interface for working with data, CUE, and its ecosystem
6976

7077
### Go release support policy
7178

0 commit comments

Comments
 (0)