Skip to content

Commit

Permalink
docs: add gh releases as an installation option
Browse files Browse the repository at this point in the history
  • Loading branch information
mrnossiom committed Jul 12, 2024
1 parent 60a37a1 commit 357575d
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,22 @@ I made this LSP wrapper implementation around `wakatime-cli` because I wanted su
## Installation

<details>
<summary>With <code>cargo</code></summary>
<summary>With <code>cargo</code></summary><br />

Install from repository with cargo:

```sh
cargo install --git https://github.com/mrnossiom/wakatime-lsp
```

While `wakatime-lsp` seems to work fine for my use case right now, I don't want to publish on `crates.io` rightaway.

You will also need `wakatime-cli` in path which you can download:

- With you prefered package manager at [`wakatime` repology](https://repology.org/project/wakatime/versions) or [`wakatime-cli` repology](https://repology.org/project/wakatime-cli/versions)
- or from [WakaTime repository artefacts](https://github.com/wakatime/wakatime-cli/releases/latest)
I don't plan on publishing pre-v1 versions on `crates.io`.

</details>

<details>
<summary>With <code>nix</code> flakes</summary>
<summary>With <code>nix</code> flakes</summary><br />

A `flake.nix` is available which means that you can use `github:mrnossiom/wakatime-lsp` as a flake identifier, so you can.
A `flake.nix` is available which means that you can use `github:mrnossiom/wakatime-lsp` as a flake identifier. That way you can:

- import this repository in your flake inputs

Expand All @@ -55,7 +50,7 @@ A `flake.nix` is available which means that you can use `github:mrnossiom/wakati

Add the package to your [NixOS](https://nixos.org/) or [Home Manager](https://github.com/nix-community/home-manager) packages depending on your installation.

- use with `nix shell`/`nix run` for temporary testing
- use with `nix shell` for temporary testing

e.g. `nix shell github:mrnossiom/wakatime-lsp`

Expand All @@ -67,6 +62,20 @@ Package is reachable through `packages.${system}.default` or `packages.${system}

</details>

<details>
<summary>Download binary from GitHub releases</summary><br />

Find the latest `wakatime-lsp` release on GitHub [here](https://github.com/mrnossiom/wakatime-lsp/releases).

You may download the compressed tarball corresponding to your OS.

</details>

For non-nixOS setups, you will also need `wakatime-cli` in path which you can download:

- with your prefered package manager, see [`wakatime` repology](https://repology.org/project/wakatime/versions) or [`wakatime-cli` repology](https://repology.org/project/wakatime-cli/versions)
- or from [`wakatime-cli` releases page](https://github.com/wakatime/wakatime-cli/releases/latest)

## Configuration

Currently `wakatime-lsp` is not configurable cause it's more of a simple `wakatime-cli` wrapper which itself is configurable with [`$WAKATIME_HOME/.wakatime.cfg`](https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md#ini-config-file).
Expand Down

0 comments on commit 357575d

Please sign in to comment.