commit 1568620772dfd7f33dd96ff004ed3de91ec50669
from: Dominik Lang <dominik@phildom.de>
date: Tue Mar 12 20:49:23 2024 UTC

Update the README to add a little information on how to use and some caveats.

commit - 1b3bcf69ccbcc60e46935aac966715fc35c35ba5
commit + 1568620772dfd7f33dd96ff004ed3de91ec50669
blob - a1d8abe890f70b15b47106f7abfd5870df57b270
blob + 63933f4eea33471855ca8de22f9b63455d362f39
--- README.md
+++ README.md
@@ -1,2 +1,18 @@
 # nushell-completions
-Command completions for nushell, mainly OpenBSD specific
+
+This is a collection of some command line completions for the [nushell][https://github.com/nushell/nushell].
+
+You can add these to nushell by adding them to your config.nu, e.g.
+
+```nushell
+use <PATH>/vmctl.nu
+```
+
+## Notes on some of the completions
+
+### unwindctl
+The current verion does not support completions for the subcommands when the "-s" flag is given.
+
+### hx
+nushell does not support "+N" option to open the first given file.
+