Skip to content

Commit

Permalink
docs(README): improved links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Feb 3, 2022
1 parent b14c84a commit 22b7bfd
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,28 @@ aw-client
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Typechecking: Mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)


[**Documentation**](https://activitywatch.readthedocs.io/en/latest/)

Client library for ActivityWatch in Python.

Please see the documentation for usage and examples.
Please see [the documentation][docs] for usage, and take a look at `examples/`.

- [Documentation][docs]
- [API Reference][apiref]

[docs]: https://docs.activitywatch.net/en/latest/
[apiref]: https://docs.activitywatch.net/en/latest/api/python.html#aw-client

## How to install

To install the latest git version directly from github without cloning, run
Install from pip: `pip install aw-client`

Install the latest version directly from github without cloning, run
`pip install git+https://github.com/ActivityWatch/aw-client.git`

To install from a cloned version, cd into the directory and run
`poetry install` to install inside an virtualenv. If you want to install it
system-wide it can be installed with `pip install .`, but that has the issue
that it might not get the exact version of the dependencies due to not reading
the poetry.lock file.
the `poetry.lock` file.

## Usage

Expand Down

0 comments on commit 22b7bfd

Please sign in to comment.