Skip to content

Commit 067eaec

Browse files
committed
Note Vetur comparison, clarify intent for eventual JS support
1 parent 29a5f1a commit 067eaec

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Glint [![CI](https://github.com/typed-ember/glint/workflows/CI/badge.svg)](https://github.com/typed-ember/glint/actions?query=workflow%3ACI)
1+
# <img src="packages/vscode/assets/glint.png" width="36" valign="top"> Glint [![CI](https://github.com/typed-ember/glint/workflows/CI/badge.svg)](https://github.com/typed-ember/glint/actions?query=workflow%3ACI)
22

33
TypeScript-powered tooling for Glimmer templates.
44

@@ -20,12 +20,13 @@ TypeScript-powered tooling for Glimmer templates.
2020

2121
## Overview
2222

23-
Glint is a set of tools to aid in developing code that uses the Glimmer VM for rendering, such as [Ember.js] and [GlimmerX] projects. It's particularly focused on static analysis of templates via TypeScript and the richer editing experience that that enables for both TS and vanilla JS projects.
23+
Glint is a set of tools to aid in developing code that uses the Glimmer VM for rendering, such as [Ember.js] and [GlimmerX] projects. Similar to [Vetur] for Vue projects, Glint consists of a CLI and a language server to provide feedback and enforce correctness both locally during editing and project-wide in CI.
2424

25-
⚠️ Note: **Glint is still under active development!** Please bear with us and expect breaking changes and rough edges as we work toward a stable release. Also note that Glint is currently only compatible with TypeScript projects.
25+
⚠️ Note: **Glint is still under active development!** Please bear with us and expect breaking changes and rough edges as we work toward a stable release. Also note that Glint is currently only compatible with TypeScript projects, but our aim is ultimately to support JavaScript as well, as TypeScript's tooling can provide best-in-class support for both TS and JS projects.
2626

2727
[ember.js]: https://www.emberjs.com
2828
[glimmerx]: https://github.com/glimmerjs/glimmer-experimental
29+
[vetur]: https://github.com/vuejs/vetur
2930

3031
## Getting Started
3132

0 commit comments

Comments
 (0)