doc: Merge pull request #12 from maxim-uvarov/update-readme

make installation instructions more convenient, add chapter about setting up auto format in helix

Author: blindFS

README.md

@@ -15,19 +15,28 @@
 
 ## setup
 
-1. install topiary-cli (0.6.0+ suggested)
-2. clone this repo to `$env.XDG_CONFIG_HOME/topiary`
-3. set environment variables
-
 ```nushell
+# install topiary-cli (0.6.0+ suggested)
+# for example, installing with cargo
+cargo install --git https://github.com/tweag/topiary topiary-cli
+
+# clone this repo to `$env.XDG_CONFIG_HOME/topiary`
+git clone https://github.com/blindFS/topiary-nushell ($env.XDG_CONFIG_HOME | path join topiary)
+
+# set environment variables
 $env.TOPIARY_CONFIG_FILE = ($env.XDG_CONFIG_HOME | path join topiary languages.ncl)
 $env.TOPIARY_LANGUAGE_DIR = ($env.XDG_CONFIG_HOME | path join topiary languages)
-
 ```
+
 ## usage
 
-+ `topiary format script.nu`
-+ neovim: format on save with [conform.nvim](https://github.com/stevearc/conform.nvim):
+```nushell
+topiary format script.nu
+```
+
+### neovim
+
+Format on save with [conform.nvim](https://github.com/stevearc/conform.nvim):
 
 ```lua
 -- lazy.nvim setup
@@ -49,6 +58,17 @@ $env.TOPIARY_LANGUAGE_DIR = ($env.XDG_CONFIG_HOME | path join topiary languages)
 },
 ```
 
+### helix
+
+To format on save in Helix, add this configuration to your `helix/languages.toml`.
+
+```toml
+[[language]]
+name = "nu"
+auto-format = true
+formatter = { command = "topiary", args = ["format", "--language", "nu"] }
+```
+
 ## contribute
 
 Help to find format issues with following method (dry-run, detects parsing/idempotence/semantic breaking):