Extend documentation ✒️ (#48)

* add links to documentation to readme/index.md

* Update pre-commit hooks 🪝

.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:

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

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

src/tclf/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.0.2"