docs: Improve README to include a video and fix text (#7)

coder3101 · Jun 22, 2024 · dd6ffd5 · dd6ffd5
1 parent 2ebbb0f
commit dd6ffd5
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,14 +1,16 @@
 [package]
 name = "protols"
 description = "Language server for proto3 files"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 license = "MIT"
 homepage = "https://github.com/coder3101/protols"
 repository = "https://github.com/coder3101/protols"
 readme = "README.md"
 keywords = ["lsp", "proto3"]
 
+exclude = ["assets/*"]
+
 [dependencies]
 async-lsp = { version = "0.2.0", features = ["tokio"] }
 futures = "0.3.30"

diff --git a/README.md b/README.md
@@ -1,15 +1,16 @@
 # protols
 A Language Server for **proto3** files. It uses tree-sitter parser for all operations and always runs in **single file mode**.
 
+![](./assets/protols.mov)
+
 ## Features 
 - [x] Hover
 - [x] Go to definition
 - [x] Diagnostics
 
-
 ## Installation and testing
 
-Clone the repository and run `cargo install protols` to install locally in your `~/.cargo/bin` and the below to your `init.lua` until we start shipping this via Mason.
+Run `cargo install protols` to install and add below to your `init.lua` until we start shipping this via Mason.
 
 ```lua
 local client = vim.lsp.start_client({

diff --git a/assets/protols.mov b/assets/protols.mov