Skip to content

Commit a3d5bf5

Browse files
jpluscplusmcueckoo
authored andcommitted
README: update
This updates and reflows the extension's README that's now displayed on the VS Code Marketplace page. Change-Id: If7d58ba7d6fefc5f405ad6dd42c71719a6885766 Signed-off-by: Jonathan Matthews <[email protected]> Dispatch-Trailer: {"type":"trybot","CL":1222333,"patchset":6,"ref":"refs/changes/33/1222333/6","targetBranch":"master"}
1 parent bcd5879 commit a3d5bf5

File tree

1 file changed

+17
-21
lines changed

1 file changed

+17
-21
lines changed

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# CUE for Visual Studio Code
22

3-
[The VS Code CUE
3+
[The official VS Code CUE
44
extension](https://marketplace.visualstudio.com/items?itemName=cuelangorg.vscode-cue)
5-
provides rich language support for the [CUE language](https://cuelang.org/).
5+
provides rich language support for [the CUE language](https://cuelang.org/)
6+
through syntax highlighting and language server integration (LSP).
67

78
## What is CUE?
89

@@ -15,43 +16,38 @@ as Go, JSON, YAML, OpenAPI, and JSON Schema.
1516
For more information and documentation, including __tutorials and guides__, see
1617
[cuelang.org](https://cuelang.org).
1718

18-
## Why is this extension useful?
19-
20-
[Visual Studio Code](https://code.visualstudio.com/) is an awesome, extensible,
21-
multi-platform editor and IDE. Its ecosystem has a massive number of plugins for
22-
different languages, and this one implements syntax highlighting (and
23-
potentially more functionality in the future) for the CUE language.
24-
2519
## Quick Start
2620

27-
Whether you are new or experienced CUE user, we hope this extension fits your
28-
needs and enhances your configuration, data and policy experience.
29-
3021
1. Make sure you have
3122
[CUE installed](https://cuelang.org/docs/introduction/installation/) on the
3223
computer that's running VS Code. We recommend installing the latest version.
3324

3425
1. Install the
3526
[VS Code CUE extension](https://marketplace.visualstudio.com/items?itemName=cuelangorg.vscode-cue).
3627

37-
1. Open any CUE file file to automatically activate the extension. The CUE
28+
1. Open any CUE file to automatically activate the extension. The CUE
3829
status bar appears in the bottom right corner of the window and displays your
3930
CUE version. The :zap: sign next to the CUE version indicates the language
4031
server is running, and you are ready to go.
4132

4233
1. Use the Command Palette, `Shift+Command+P` (Mac) / `Ctrl+Shift+P`
43-
(Windows/Linux), to run CUE-specific commands. They are all prefixed with
44-
`CUE:`.
34+
(Windows/Linux), to run CUE-specific commands. Find them through their
35+
common `CUE: ` prefix.
36+
37+
## Feedback
38+
39+
Whether you're new to CUE, or an experienced user, we hope this extension fits
40+
your needs and enhances your configuration, data and policy experience.
41+
42+
Please give us feedback through GitHub [issues](https://cuelang.org/issues) and
43+
[discussions](https://cuelang.org/discussions) in the main CUE repo - we really
44+
value your input, experiences with the extension, and ideas!
4545

4646
## Credits
4747

4848
This project was started by [betawaffle](https://github.com/betawaffle) who
49-
graciously permitted that it be moved to a more general home in the
50-
[cue-sh](https://github.com/cue-sh) (which is part of the [CUE
51-
Project](https://cuelang.org)), before then being migrated to the
52-
[cue-lang](https://github.com/cue-lang) organisation which more clearly
53-
identifies it as part of the CUE Project along with the [main CUE
54-
repository](https://github.com/cue-lang/cue).
49+
graciously permitted that it be moved to a new location to help identify it as
50+
part of [the CUE project](https://cuelang.org).
5551

5652
## Contributing
5753

0 commit comments

Comments
 (0)