Add a README

README.md

@@ -0,0 +1,42 @@
+<div align="center">
+<h1>zk-vscode</h1>
+<h4>A Visual Studio Code extension for <a href="https://github.com/mickael-menu/zk"><code>zk</code></a></h4>
+<h5><a href="https://marketplace.visualstudio.com/items?itemName=mickael-menu.zk-vscode"><b>Install from the Marketplace</b></a></h5>
+</div>
+
+
+## Description
+
+[`zk`](https://github.com/mickael-menu/zk) is a command-line tool helping you to maintain a plain text [Zettelkasten](https://zettelkasten.de/introduction/) or [personal wiki](https://en.wikipedia.org/wiki/Personal_wiki). It provides a Language Server to augment LSP-compatible editors with many features such as auto-completion and navigation.
+
+`zk-vscode` is a Visual Studio Code client extension for `zk`'s Language Server.
+
+### Highlights
+
+* Follow note links (including Wiki-links)
+
+* Complete links ([configure Wiki-links in `zk`'s configuration file](https://github.com/mickael-menu/zk/blob/main/docs/note-format.md))
+
+    <img alt="Link completion" width="675px" src="media/screenshots/link-completion.png"/>
+
+* Complete tags
+
+    <img alt="Tag completion" width="675px" src="media/screenshots/tag-completion.png"/>
+
+* Preview a note on hover
+
+    <img alt="Hover" width="675px" src="media/screenshots/hover.png"/>
+
+* Peek a note with "Peek definition"
+
+    <img alt="Peek note" width="675px" src="media/screenshots/peek.png"/>
+
+## Troubleshooting issues
+
+If you experience issues with `zk-vscode`, you can peek at the Language Server logs with the **zk: Show Logs** VS Code command. To get more detailed logs, set the verbose mode in your `settings.json`:
+
+```json
+{
+    "zk.trace.server": "verbose"
+}
+```

package.json

@@ -2,7 +2,9 @@
   "name": "zk-vscode",
   "displayName": "zk-vscode",
   "description": "Visual Studio Code extension for zk",
-  "version": "0.0.1",
+  "publisher": "mickael-menu",
+  "version": "0.1.0",
+  "repository": { "type": "git", "url": "https://github.com/mickael-menu/zk-vscode.git" },
   "engines": {
     "vscode": "^1.55.0"
   },