From 357575dfe695369979f6fd0e7975898f863d8e35 Mon Sep 17 00:00:00 2001 From: Milo Moisson Date: Fri, 12 Jul 2024 23:55:24 +0200 Subject: [PATCH] docs: add gh releases as an installation option --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f953064..1890931 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ I made this LSP wrapper implementation around `wakatime-cli` because I wanted su ## Installation
- With cargo + With cargo
Install from repository with cargo: @@ -30,19 +30,14 @@ Install from repository with cargo: 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`.
- With nix flakes + With nix flakes
-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 @@ -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` @@ -67,6 +62,20 @@ Package is reachable through `packages.${system}.default` or `packages.${system}
+
+ Download binary from GitHub releases
+ +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. + +
+ +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).