Skip to content

Commit 9bca1c3

Browse files
committed
Expand the README a bit
1 parent 72b0a60 commit 9bca1c3

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

Diff for: README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,15 @@ highlighting), indentation, and navigation support for the
1818
for a very long time, but it suffers from a few [long-standing
1919
problems](https://github.com/clojure-emacs/clojure-mode#caveats), related to
2020
Emacs limitations baked into its design. The introduction of built-in support
21-
for Tree-sitter in Emacs 29 provides a natural opportunity to address many of
22-
them. Enter `clojure-ts-mode`.
21+
for Tree-sitter in Emacs 29 presents a natural opportunity to address many of
22+
them. Enter `clojure-ts-mode`, which makes use of TreeSitter to provide:
23+
24+
- fast, accurate and more granular font-locking
25+
- fast indentation
26+
- common Emacs functionality like structured navigation, `imenu` (an outline of a source buffer), current form inference (used internally by various Emacs modes and utilities), etc
27+
28+
Working with TreeSitter is significantly easier than the legacy Emacs APIs for font-locking and
29+
indentation, which makes it easier to contribute to `clojure-ts-mode`, and to improve it in general.
2330

2431
Keep in mind that the transition to `clojure-ts-mode` won't happen overnight for several reasons:
2532

@@ -37,6 +44,11 @@ You can read more about the vision for `clojure-ts-mode` [here](https://metaredu
3744

3845
**This library is still under active development. Breaking changes should be expected.**
3946

47+
The currently provided functionality should cover the needs of most Clojure programmers, but you
48+
can expect to encounter some bugs and missing functionality here and there.
49+
50+
Those will be addressed over the time, as more and more people use `clojure-ts-mode`.
51+
4052
## Installation
4153

4254
### Emacs 29

0 commit comments

Comments
 (0)