From d44b74f990c3e2d03d9a3ced3a89ffa619b59d63 Mon Sep 17 00:00:00 2001
From: Markus Bilz <mail@markusbilz.com>
Date: Thu, 28 Dec 2023 14:36:11 +0100
Subject: [PATCH] =?UTF-8?q?Extend=20documentation=20=E2=9C=92=EF=B8=8F=20(?=
 =?UTF-8?q?#48)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* add links to documentation to readme/index.md

* Update pre-commit hooks 🪝
---
 .pre-commit-config.yaml |  4 ++--
 README.md               | 10 ++++++++--
 docs/index.md           | 10 ++++++++--
 src/tclf/__init__.py    |  2 +-
 4 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 9010ed3..d014bdf 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -18,14 +18,14 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.1
+    rev: v1.8.0
     hooks:
       - id: mypy
         # yaml requires additional stubs.
         # Similar to: https://stackoverflow.com/a/73603491/5755604
         additional_dependencies: ['types-PyYAML']
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.8
+    rev: v0.1.9
     hooks:
     - id: ruff
       args:
diff --git a/README.md b/README.md
index 3796fc2..9b708c9 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@
 [![codecov](https://codecov.io/gh/KarelZe/tclf/branch/main/graph/badge.svg?token=CBM1RXGI86)](https://codecov.io/gh/KarelZe/tclf/tree/main/graph)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=KarelZe_tclf&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=KarelZe_tclf)
 
+
+**Documentation ✒️:** [https://karelze.github.io/tclf/](https://karelze.github.io/tclf/)
+
+**Source Code 🐍:** [https://github.com/KarelZe/tclf](https://github.com/KarelZe/tclf)
+
+
 `tclf` is a [`scikit-learn`](https://scikit-learn.org/stable/)-compatible implementation of trade classification algorithms to classify financial markets transactions into buyer- and seller-initiated trades.
 
 The key features are:
@@ -14,9 +20,9 @@ The key features are:
 
 ## Installation
 ```console
-$ pip install .
+$ python -m pip install tclf
 ---> 100%
-Successfully installed tclf-0.0.1
+Successfully installed tclf-0.0.2
 ```
 
 ## Supported Algorithms
diff --git a/docs/index.md b/docs/index.md
index 3796fc2..9b708c9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,6 +4,12 @@
 [![codecov](https://codecov.io/gh/KarelZe/tclf/branch/main/graph/badge.svg?token=CBM1RXGI86)](https://codecov.io/gh/KarelZe/tclf/tree/main/graph)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=KarelZe_tclf&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=KarelZe_tclf)
 
+
+**Documentation ✒️:** [https://karelze.github.io/tclf/](https://karelze.github.io/tclf/)
+
+**Source Code 🐍:** [https://github.com/KarelZe/tclf](https://github.com/KarelZe/tclf)
+
+
 `tclf` is a [`scikit-learn`](https://scikit-learn.org/stable/)-compatible implementation of trade classification algorithms to classify financial markets transactions into buyer- and seller-initiated trades.
 
 The key features are:
@@ -14,9 +20,9 @@ The key features are:
 
 ## Installation
 ```console
-$ pip install .
+$ python -m pip install tclf
 ---> 100%
-Successfully installed tclf-0.0.1
+Successfully installed tclf-0.0.2
 ```
 
 ## Supported Algorithms
diff --git a/src/tclf/__init__.py b/src/tclf/__init__.py
index f102a9c..3b93d0b 100644
--- a/src/tclf/__init__.py
+++ b/src/tclf/__init__.py
@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.0.2"