From bc0c560306192be2fa20784c32908fd80897531f Mon Sep 17 00:00:00 2001 From: bestgopher <84328409@qq.com> Date: Thu, 29 Aug 2024 21:17:09 +0800 Subject: [PATCH] docs: update readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 07c28c7..74a4135 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -# zed-code-stats +# wakatime-zed A [Wakatime](https://wakatime.com/) extension for [Zed](https://zed.dev/). -Uses the [wakatime-ls](https://github.com/bestgopher/wakatime-zed/wakatime-ls) to receive edit events from Zed and send hearbeat to Wakatime by [wakatime-cli](https://github.com/wakatime/wakatime-cli). +Uses the [wakatime-ls](https://github.com/bestgopher/wakatime-zed/tree/master/wakatime-ls) to receive edit events from Zed and send hearbeats to Wakatime by [wakatime-cli](https://github.com/wakatime/wakatime-cli). ## Configuration In order to authenticate with the Wakatime-cli, the language server needs to know your API token. -Here are two ways to configurate the lsp. +Here are two ways to set the lsp. ### Wakatime configuration file -1. create a file named `.wakatime.cfg`, locate your HOME directory. +create a file named `.wakatime.cfg`, locate your HOME directory. ```toml [settings] api_key = Your api key ``` -2. Zed setting.Open zed setting file, add your api key -```toml + +### zed setting file +Zed setting.Open zed setting file, add your api key +```json "lsp": { "wakatime": { "settings": {