-
-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README with better general information about ActivityWatch
- Loading branch information
Showing
1 changed file
with
26 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,37 @@ | ||
ActivityWatch | ||
============= | ||
|
||
**[Website](http://activitywatch.github.io)** || **[Documentation](http://activitywatch.readthedocs.io)** | ||
|
||
[![Build Status](https://travis-ci.org/ActivityWatch/activitywatch.svg?branch=master)](https://travis-ci.org/ActivityWatch/activitywatch) | ||
[![Documentation](https://readthedocs.org/projects/activitywatch/badge/?version=latest)](http://activitywatch.readthedocs.io) | ||
|
||
This repo is a bundle of the core components and official modules of ActivityWatch, it is also where releases of the full suite are published. | ||
## About ActivityWatch | ||
|
||
It's primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation. | ||
ActivityWatch is about recording what you do, so you can become aware of what you do, and choose to do better. All in a way where you control the data. | ||
|
||
**Note:** ActivityWatch is under development. There is still work to be done so we provide it with no guarantees with the hope that others may wish to help and give their feedback! | ||
|
||
You can read more on our [website](https://activitywatch.github.io/about/). | ||
|
||
#### Server | ||
The *aw-server* project is the official implementation of the core service which the other activitywatch services interact with. It provides a datastore and serves the web interface developed in the *aw-webapp* project (which provides the frontend part of the webapp). | ||
|
||
The webapp includes basic data visualization (WIP), data browsing and export, and has a lot planned for it. | ||
|
||
***TODO:*** Add screenshots of the webapp. | ||
|
||
#### Watchers | ||
|
||
## Other uses | ||
- *aw-watcher-afk* - can be used to log the presence/absence of user activity from keyboard and mouse input | ||
- *aw-watcher-window* - can be used to log the currently active application and it's window title | ||
- *aw-core* - core library, provides no runnable modules | ||
|
||
|
||
## About this repository | ||
|
||
This repo is a bundle of the core components and official modules of ActivityWatch. it Is also where releases of the full suite are published (see [releases](https://github.com/ActivityWatch/activitywatch/releases)). | ||
|
||
It's primary use is as a meta-package providing all the components in one repo; enabling easier packaging and installation. | ||
|
||
This is also the repo where issues about ActivityWatch in general should go, such as requests and discussion regarding new features. | ||
This is also the repo where issues about ActivityWatch *in general* should go, such as requests and discussion regarding new features. | ||
|