[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/bicep-ts-mode 097a8b46e7 3/3: Update readme
From: |
ELPA Syncer |
Subject: |
[elpa] externals/bicep-ts-mode 097a8b46e7 3/3: Update readme |
Date: |
Mon, 15 Jan 2024 15:57:51 -0500 (EST) |
branch: externals/bicep-ts-mode
commit 097a8b46e70814b75bce8b36917f361c7b614024
Author: Jostein Kjønigsen <jostein@kjonigsen.net>
Commit: Jostein Kjønigsen <jostein@kjonigsen.net>
Update readme
---
README.md | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index fc845a210e..52d77aa4f8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
# bicep-ts-mode
-Tree-sitter powered Bicep-support for GNU Emacs
+
+[Bicep](https://github.com/Azure/bicep)-support for [GNU
+Emacs](https://www.gnu.org/software/emacs/), powered by the
+[tree-sitter](https://tree-sitter.github.io/tree-sitter/) parser library.
+
+## Features supported
+
+- Syntax highlighting
+- Indentation
+- Imenu-support, when LSP not configured
+
+## Prerequisites
+
+To use this package with GNU Emacs you need the following
+prerequisites:
+
+- GNU Emacs built with tree-sitter support enabled
+- [Bicep language grammar for
tree-sitter](https://github.com/amaanq/tree-sitter-bicep)
+