Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bestgopher committed Aug 29, 2024
1 parent 9a6a7c4 commit bc0c560
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit bc0c560

Please sign in to comment.