Update README

README.md

@@ -1,28 +1,30 @@
-# Bash for Zed
+# Bash suppport for Zed
 
-Tree Sitter: https://github.com/tree-sitter/tree-sitter-bash
+Tree-sitter: https://github.com/tree-sitter/tree-sitter-bash
 
 Language Server: https://github.com/bash-lsp/bash-language-server
 
-![image.png](https://s2.loli.net/2024/03/30/ISb1wqOCYaZtLyc.png)
+![lsp-example.png](./assets/lsp-example.png)
 
 # shellcheck
 
-The [bash-language-server](https://github.com/bash-lsp/bash-language-server) support shellcheck.
-But you need to [install it manually](https://github.com/koalaman/shellcheck#installing)
+The [bash-language-server](https://github.com/bash-lsp/bash-language-server) supports shellcheck.
+However, you need to [install shellcheclk manually](https://github.com/koalaman/shellcheck#installing)
 
 ```bash
-brew install shellcheck         # macOS
-sudo apt-get install shellcheck # ubuntu/debian
+brew install shellcheck         # MacOS
+sudo apt-get install shellcheck # Ubuntu / Debian
 sudo pacman -S shellcheck       # Arch Linux
 choco install shellcheck        # Windows (chocolatey)
 ```
 
 ## Shellcheck ignores
 
-If you wish to ignore certain ShellCheck warnings in your files you can add an inline comment `# shellcheck disable=SC0000` specifying the warning/error.
+If you wish to ignore certain ShellCheck warnings in your files, you can add an inline comment `# shellcheck disable=SC0000` specifying the warning/error.
 
-Alternatively, if you'd like to ignore something for an entire file, put the comment at the top of the file.  For example to ignore [SC2034](https://www.shellcheck.net/wiki/SC2034) `foo appears unused. Verify it or export it.` in an `.env` file it would look like so:
+Alternatively, if you'd like to ignore something for an entire file, put the comment at the top of the file.
+
+For example, to ignore [SC2034](https://www.shellcheck.net/wiki/SC2034) `foo appears unused. Verify it or export it.` in an `.env` file, it would look like so:
 
 ```sh
 # shellcheck disable=SC2034
@@ -33,49 +35,13 @@ DATABASE_URL="postgres://something"
 
 # shfmt
 
-bash-language-server can support formatting using `shfmt` if it is available in your path.  Install with:
+bash-language-server can support formatting using `shfmt` if it is available in your path. Install with:
 
 ```sh
-brew install shfmt         # macOS
-sudo apt-get install shfmt # ubuntu/debian
+brew install shfmt         # MacOS
+sudo apt-get install shfmt # Ubuntu / Debian
 sudo pacman -S shfmt       # Arch Linux
 choco install shfmt        # Windows (chocolatey)
 ```
 
-To control automatic formatting, in your Zed settings use [`format_on_save`](https://zed.dev/docs/configuring-zed#format-on-save) or manually invoke `editor: format document` from the command palette.
-
-# tldr vs man
-
-`bash-language-server` use `man` to show document 👀
-
-The markdown rendering is completely bad
-
-So, let's just use the documentation provided by tldr (it's really a markdown display!)
-
-github: https://github.com/d1ylab/bash-language-server
-
-npm: https://www.npmjs.com/package/neo-bash-ls
-
-| After      | Before |
-| ----------- | ----------- |
-| ![image.png](https://s2.loli.net/2024/05/15/WNXcxehtRAf2I9a.png)      | ![image.png](https://s2.loli.net/2024/05/15/IPitmeKo8Awjq25.png)       |
-
-Apply the patch
-
-```diff
-diff --git a/src/bash.rs b/src/bash.rs
-index d9cdd6b..d8fc8f5 100644
---- a/src/bash.rs
-+++ b/src/bash.rs
-@@ -1,8 +1,8 @@
- use std::{env, fs};
- use zed_extension_api::{self as zed, Result};
-
--const SERVER_PATH: &str = "node_modules/bash-language-server/out/cli.js";
--const PACKAGE_NAME: &str = "bash-language-server";
-+const SERVER_PATH: &str = "node_modules/neo-bash-ls/out/cli.js";
-+const PACKAGE_NAME: &str = "neo-bash-ls";
-
- struct BashExtension {
-     did_find_server: bool,
-```
+To control automatic formatting you can use [`format_on_save`](https://zed.dev/docs/configuring-zed#format-on-save) in your Zed settingts or manually invoke `editor: format document` from the command palette.