docs: update readme

Author: yuukidach

README.md

@@ -2,14 +2,23 @@
 
 A command line tool for Twitch analytics. This is originally a group project of my class at school.
 
+Here is an eaxmple web page generated by this program.
+
+![](./docs/res/web.png)
+
+If you want to try this command line tool, you can go to [example](#example) part directry.
 ## Table of Contents
 
 * [Backgournd](#background)
 * [Installation](#installation)
 * [Usage](#usage)
+  + [save-user](#save-user-command)
+  + [collect](#collect-command)
+  + [process](#process-command)
 * [Example](#example)
   + [[Opitional] Save ID and Secret](#optional-save-id-and-secret)
   + [Collect Data](#collect-data)
+  + [Process Data](#process-data)
 * [Guide for Developing This Tool](#guide-for-developing-this-tool)
   * [Other Available Online Resources](#other-available-online-resources)
 * [Contributors](#contributors)
@@ -41,6 +50,7 @@ Options:
 
 Commands:
   collect    Collect data for analysis
+  process    Process data and do visualization.
   save-user  Save user id and secret key in `secret.yaml`.
 ```
 
@@ -59,7 +69,7 @@ Options:
   --help  Show this message and exit.
 ```
 
-### collect command
+### collect Command
 
 `collect` command is one of the most important command in this tool. It used to collect top games data and related streams data into csv files. Later, we can use these files to do data analysis.
 
@@ -77,6 +87,24 @@ Options:
   --help                        Show this message and exit.
 ```
 
+### process Command
+
+This command is to process data and show analized results in figures.
+
+``` shell
+Usage: twitchanal process [OPTIONS]
+
+  Process data and do visualization.
+
+Options:
+  --debug               Run in debug mode.
+  -d, --dir TEXT        Data directory.
+  -t, --timestamp TEXT  Data timestamp. Specify which csv file to use or the
+                        program will use the latest one by default.
+
+  --help                Show this message and exit.
+```
+
 ## Example
 
 ### [Optional] Save ID and Secret
@@ -111,8 +139,18 @@ dataset
 
 There suffix of the file name is a timestamp. It tells us when we collect the data. **But it is just a approximate time**. This tool uses the time of starting collect `top_games` as the timestamp for all data files. Since we do not need a accurate time to do data analysis. This is acceptable.
 
-`top_games_xxxx.csv` contains the data of top games.
-`game_streams_xxxx.csv` contains the data of a certain game stream.
+- `top_games_xxxx.csv` contains the data of top games.
+- `game_streams_xxxx.csv` contains the data of a certain game stream.
+
+### Process Data
+
+``` shell
+twichanal process [-d] [-t]
+```
+
+Program will create a web page and run on http://127.0.0.1:8050/
+
+![](./docs/res/web.png)
 
 ## Guide for Developing This Tool
 

src/twitchanal/cli.py

@@ -69,12 +69,14 @@ def collect(dir: str, timestamp: bool, num: int, stream: int, extra: bool,
               is_flag=True,
               default=False,
               help='Run in debug mode.')
-@click.option('--dir', '-d', 
-              default='dataset',
-              help='Data directory.')
-@click.option('--timestamp', '-t',
-              default=None,
-              help='Data timestamp.')
+@click.option('--dir', '-d', default='dataset', help='Data directory.')
+@click.option(
+    '--timestamp',
+    '-t',
+    default=None,
+    help=
+    'Data timestamp. Specify which csv file to use or the program will use the latest one by default.'
+)
 def process(debug: bool, dir: str, timestamp: str):
     """ Process data and do visualization.
     """