Skip to content

Commit dd6ffd5

Browse files
authored
docs: Improve README to include a video and fix text (#7)
1 parent 2ebbb0f commit dd6ffd5

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

Cargo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
[package]
22
name = "protols"
33
description = "Language server for proto3 files"
4-
version = "0.1.0"
4+
version = "0.1.1"
55
edition = "2021"
66
license = "MIT"
77
homepage = "https://github.com/coder3101/protols"
88
repository = "https://github.com/coder3101/protols"
99
readme = "README.md"
1010
keywords = ["lsp", "proto3"]
1111

12+
exclude = ["assets/*"]
13+
1214
[dependencies]
1315
async-lsp = { version = "0.2.0", features = ["tokio"] }
1416
futures = "0.3.30"

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# protols
22
A Language Server for **proto3** files. It uses tree-sitter parser for all operations and always runs in **single file mode**.
33

4+
![](./assets/protols.mov)
5+
46
## Features
57
- [x] Hover
68
- [x] Go to definition
79
- [x] Diagnostics
810

9-
1011
## Installation and testing
1112

12-
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.
13+
Run `cargo install protols` to install and add below to your `init.lua` until we start shipping this via Mason.
1314

1415
```lua
1516
local client = vim.lsp.start_client({

assets/protols.mov

4.94 MB
Binary file not shown.

0 commit comments

Comments
 (0)