Skip to content

Commit

Permalink
docs: install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AllanChain committed Jan 10, 2024
1 parent 4b7a77a commit f05d312
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,26 @@
[![Github Actions Status](https://github.com/AllanChain/waka-jlab/workflows/Build/badge.svg)](https://github.com/AllanChain/waka-jlab/actions/workflows/build.yml)
A JupyterLab WakaTime extension.

This extension is composed of a Python package named `waka_jlab`
for the server extension and a NPM package named `waka-jlab`
for the frontend extension.

## Requirements

- JupyterLab >= 4.0.0

## Install


> [!Warning]
>
> This plugin is at a VERY early stage! You should setup WakaTime manually.
If `~/.wakatime/wakatime-cli` doesn’t exist, download the `wakatime-cli` zip file for the current OS and architecture from the [latest release](https://github.com/wakatime/wakatime-cli/releases) then unzip it into `~/.wakatime/`.

And in `~/.wakatime.cfg`, write:

```ini
[settings]
api_key=waka_YOUR_API_KEY_HERE
```

To install the extension, execute:

```bash
Expand All @@ -27,6 +37,10 @@ To remove the extension, execute:
pip uninstall waka_jlab
```

The following content is generated with the template:

---

## Troubleshoot

If you are seeing the frontend extension, but it is not working, check
Expand Down

0 comments on commit f05d312

Please sign in to comment.