<commit_before>Watson [![Build Status](https://travis-ci.org/TailorDev/Watson.svg)](https://travis-ci.org/TailorDev/Watson)
======

Watson is here to help you monitoring your time. You want to know how much time
you are spending on your projects ? You want to generate a nice report for your
client ? Watson is here for you.

Tell Watson when you start working on a task with the `start` command. Then,
when you are done with this task, stop the timer with the `stop` command.
That's pretty much everything you need to know to start using Watson.

Each task consists of the name of a project and some tags. Your tags can be shared
across projects and can be used to generate detailed reports.

Watson stores everything on your computer, but you can go wild and use
[Crick](http://crick.fr) to store your sessions remotely and share it with your
coworkers.

<p align="center">
  <img src="screenshot.png" alt="Watson"/>
</p>


## Commands

Here is the listing of all the commands available with Watson. You can also
find this help with `watson help`.

### start

Start monitoring the time for the given project. You can add tags
indicating more specifically what you are working on with '+tag'.

```
Example :
$ watson start apollo11 +module +brakes
Starting apollo11 [module, brakes] at 16:34
```

### stop

Stop monitoring time for the current project
<commit_msg>Add install instructions to the README<commit_after>Watson [![Build Status](https://travis-ci.org/TailorDev/Watson.svg)](https://travis-ci.org/TailorDev/Watson)
======

Watson is here to help you monitoring your time. You want to know how much time
you are spending on your projects ? You want to generate a nice report for your
client ? Watson is here for you.

Tell Watson when you start working on a task with the `start` command. Then,
when you are done with this task, stop the timer with the `stop` command.
That's pretty much everything you need to know to start using Watson.

Each task consists of the name of a project and some tags. Your tags can be shared
across projects and can be used to generate detailed reports.

Watson stores everything on your computer, but you can go wild and use
[Crick](http://crick.fr) to store your sessions remotely and share it with your
coworkers.

<p align="center">
  <img src="screenshot.png" alt="Watson"/>
</p>

## Install

Watson is available on any platform supported by Python (Windows, Mac, Linux,
*BSD…). We are working on providing a clean and easy way to install it for each
platform, but for now the easiest way is to run the following commands:

```bash
$ git clone https://github.com/TailorDev/Watson.git
$ cd Watson/
$ sudo python setup.py install
```

The sudo is needed to install Watson for the system, so that it can be accessed
from anywhere.

## Commands

Here is the listing of all the commands available with Watson. You can also
find this help with `watson help`.

### start

Start monitoring the time for the given project. You can add tags
indicating more specifically what you are working on with '+tag'.

```
Example :
$ watson start apollo11 +module +brakes
Starting apollo11 [module, brakes] at 16:34
```

### stop

Stop monitoring time for the current project

{'fraction_non_alphanumeric': 0.07745159275452843, 'fraction_numerical': 0.004996876951905059, 'mean_word_length': 4.250819672131148, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2512342', 'n_tokens_mistral': 928, 'n_tokens_neox': 876, 'n_words': 479}