Skip to content

Commit 89e4091

Browse files
committed
docs: rework readme a bit
1 parent 8598bc6 commit 89e4091

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ A dead-simple language server around <code>wakatime-cli</code> to send code trac
55
</strong></p>
66

77
<p align="center">
8-
<img alt="Nix Powered" src="https://img.shields.io/badge/Nix-Powered-blue?logo=nixos" />
9-
<a href="https://wakatime.com/badge/github/mrnossiom/wakatime-ls">
10-
<img alt="Time spent on wakatime-ls" src="https://wakatime.com/badge/github/mrnossiom/wakatime-ls.svg" />
8+
<a href="https://nixos.org/">
9+
<img alt="Nix Powered" src="https://img.shields.io/badge/Nix-Powered-blue?logo=nixos" />
1110
</a>
12-
<a href="https://discord.gg/GrbpRNza5j">
13-
<img alt="Join support Discord" src="https://img.shields.io/badge/Support-Join-3178C6?style=social&logo=Discord" />
11+
<a href="https://matrix.to/#/#wakatime-ls:wiro.world">
12+
<img alt="Matrix room at #wakatime-ls:wiro.world" src="https://img.shields.io/badge/Matrix-%23wakatime--ls%3Awiro.world-white?logo=matrix">
1413
</a>
1514
</p>
1615

1716
I made this language server wrapper implementation around `wakatime-cli` because I wanted support for WakaTime in [Helix](https://github.com/helix-editor/helix). That said, it's should be compatible with every LSP implementation.
1817

18+
`wakatime-ls` listens to open, change, save and close file events. It then reflects this activity by sending heartbeats via the `wakatime-cli`.
19+
1920
# Installation
2021

2122
<details>
@@ -24,11 +25,12 @@ I made this language server wrapper implementation around `wakatime-cli` because
2425
Install from repository with cargo:
2526

2627
```sh
28+
# from crates.io
29+
cargo install wakatime-ls
30+
# or from source
2731
cargo install --git https://github.com/mrnossiom/wakatime-ls
2832
```
2933

30-
I don't plan on publishing pre-v1 versions on `crates.io`.
31-
3234
</details>
3335

3436
<details>
@@ -123,10 +125,10 @@ language-servers = ["nil", "wakatime"]
123125

124126
## And more...
125127

126-
`wakatime-ls` is an LSP so it is easy to quickly integrate into any editor.
128+
`wakatime-ls` is a language server, it's easy to quickly integrate into any editor that support the language server protocol.
127129

128130
Feel free to make a PR for your own favorite editor.
129131

130-
---
132+
# License
131133

132-
Work is licensed under [`CECILL-2.1`](https://choosealicense.com/licenses/cecill-2.1/), a French OSS license that allows modification and distribution of the software while requiring the same license for derived works.
134+
Work is licensed under [CECILL-2.1](https://choosealicense.com/licenses/cecill-2.1/), a French OSS license that allows modification and distribution of the software while requiring the same license for derived works.

0 commit comments

Comments
 (0)