Skip to content

Commit

Permalink
Merge pull request #49 from ActivityWatch/doc/readme-update
Browse files Browse the repository at this point in the history
Add install instructions to README.md
  • Loading branch information
johan-bjareholt committed Apr 25, 2020
2 parents 07bb9c2 + 3a4367c commit bd8a953
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,13 @@ Client library for ActivityWatch in Python.

Please see the documentation for usage and examples.

## How to install

To install the latest git 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.

0 comments on commit bd8a953

Please sign in to comment.