From 4d8bf9c450d1fac112e19c1b0b63bb72a3693852 Mon Sep 17 00:00:00 2001
From: Zhichao Zhang <zhichao.zhang@stud.tu-darmstadt.de>
Date: Mon, 5 Sep 2022 21:07:26 +0200
Subject: [PATCH] add documentation address in readme file

---
 README.md | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f16f8d7..a129061 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
 # pykkn
 
-Python port of the matlab library kkn https://git.rwth-aachen.de/nils.preuss/rdm-kraken/
-Another mythical sea monster as name maybe? 
+PYKKN is a library that supports researchers to store their data in a HDF5 file using Python. The library can handle different types of inputs like array, matrix, image and video.
+
+## Documentation
+The documentation can be found [here](https://fst-tuda.pages.rwth-aachen.de/public/pykkn/).
+
+# Repository
+https://git.rwth-aachen.de/fst-tuda/public/pykkn
\ No newline at end of file
-- 
GitLab