Add README.md

harry-hov · Sep 22, 2023 · 065081f · 065081f
1 parent 2b19d5f
commit 065081f
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# `gnopls`, the Gno language server
+
+`gnopls` (pronounced "Gno please") is the unofficial Gno [language server]. It provides IDE features to any [LSP]-compatible editor.
+
+## Installation
+
+If you do want to get the latest stable version of `gnopls`, run the following
+command:
+
+- Using `go install`
+    ```sh
+    go install github.com/harry-hov/gnopls@latest
+    ```
+
+- From source code
+    ```sh
+    git clone https://github.com/harry-hov/gnopls.git
+    cd gnopls
+    make install
+    ```
+
+If you are having issues with `gnopls`, please feel free to open an issue.
+