branch: elpa/treesit-fold
commit f49df1ea3d6143505bb3dca3dd392655ed8f7147
Author: Jen-Chieh Shen <[email protected]>
Commit: Jen-Chieh Shen <[email protected]>
Update doc
---
README.md | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index d4210ea1f2..aceebe554f 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
tree-sitter-fold builds on top of
[elisp-tree-sitter](https://github.com/emacs-tree-sitter/elisp-tree-sitter)
to provide code folding base on the tree-sitter syntax tree.
-## :floppy_disk: Installation
+## 💾 Installation
#### Methods 1. with `straight.el` and `use-package`:
@@ -30,7 +30,7 @@ then in Emacs:
(require 'tree-sitter-fold)
```
-## :card_index: Usage
+## 📇 Usage
| Commands | Description
|
|-------------------------------------|-----------------------------------------------------------------------------|
@@ -41,13 +41,13 @@ then in Emacs:
| `tree-sitter-fold-open-all` | open all folded syntax nodes in the
current buffer. |
| `tree-sitter-fold-toggle` | toggle the syntax node at `point'.
|
-## :hammer: Supported languages
+## 🔨 Supported languages
+
+These languages are fairly complete:
-* Agda (WIP)
* Bash
-* C / C++ / C# CSS
+* C / C++ / C# / CSS
* Go
-* HTML
* Java / JavaScript / JSX / JSON
* Nix
* PHP / Python
@@ -55,6 +55,11 @@ then in Emacs:
* Scala / Swift
* TypeScript / TSX
+These languages are in development:
+
+* Agda
+* HTML
+
## Contribution
Enable `tree-sitter-mode` first, then `tree-sitter-query-builder` is useful to
test
