From a1d99e310c018665214b4237e2b848b2b554a34b Mon Sep 17 00:00:00 2001
From: Johannes Spangenberg <johannes.spangenberg@hotmail.de>
Date: Tue, 30 Apr 2024 00:37:26 +0200
Subject: [PATCH] Try to make README.md less misleading

The README.md listed multiple features which are currently not
implemented. While the README.md didn't claim that these features are
currently implemented, people reading the description might interpret it
that way. The new description is hopefully more clear about what is
currently implemented.
---
 README.md | 49 ++++++++++++++++++++++++++-----------------------
 1 file changed, 26 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 02a6a3dd..cdf06379 100644
--- a/README.md
+++ b/README.md
@@ -5,17 +5,20 @@
 
 <!-- Plugin description -->
 
-This plugin has the goal of being generally useful when working with nixpkgs/NixOS/nixops, it aims
-to provide the following:
-
-* Syntax Highlighting
-* Linting
-* Profile management
-* Suggestions for:
-    * Attributes
-    * Builtins
-    * Filesystem paths
-* Templates for common usage patterns
+This plugin has the goal of being generally useful when working with nixpkgs/NixOS/nixops.
+It currently adds support for the Nix language.
+The following features are available:
+
+ *  Syntax Highlighting
+ *  Real time detection of syntax errors
+
+We would also like to provide additional support for Nix/NixOS/NixOps,
+but the following features are currently **not implemented**:
+
+ *  Linting, code completion, formatting
+ *  Profile management
+ *  Run configurations
+ *  Templates for common usage patterns
 
 <!-- Plugin description end -->
 
@@ -26,17 +29,17 @@ to provide the following:
 The plugin can be found at the Jetbrains plugin repository as
 [NixIDEA][marketplace].
 
-* Goto **File > Settings > Plugins > Marketplace**
-* Type **NixIDEA** into the search bar
-* Click **Install**
+ *  Goto **File > Settings > Plugins > Marketplace**
+ *  Type **NixIDEA** into the search bar
+ *  Click **Install**
 
 ### From ZIP file
 
 You can also install the plugin from a ZIP file.
 
-* Goto **File > Settings > Plugins**
-* Click onto the **wheel icon** on the top
-* Choose **Install Plugin from Disk**
+ *  Goto **File > Settings > Plugins**
+ *  Click onto the **wheel icon** on the top
+ *  Choose **Install Plugin from Disk**
 
 You can find corresponding ZIP files [on GitHub][releases] or build them
 yourself as described below.
@@ -47,12 +50,12 @@ yourself as described below.
 
 Follow the following steps before you build the project the first time.
 
-* Clone the repository
-* Ensure that you have a JDK for Java 11 or higher on your PATH
-* Only on NixOS: Setup JetBrains Runtime (JBR) from `<nixpkgs>`
-  ```sh
-  nix-build '<nixpkgs>' -A jetbrains.jdk -o jbr
-  ```
+ *  Clone the repository
+ *  Ensure that you have a JDK for Java 11 or higher on your PATH
+ *  Only on NixOS: Setup JetBrains Runtime (JBR) from `<nixpkgs>`
+    ```sh
+    nix-build '<nixpkgs>' -A jetbrains.jdk -o jbr
+    ```
 
 ### Build execution