fix #2

jakobgabriel · jakobgabriel · commit ee5f723c6181 · 2024-12-26T16:26:30.000+01:00
diff --git a/README.md b/README.md
@@ -38,12 +38,12 @@ Besides that multiple engineering specific methods are utilized to make it fast
 Install ts-shape using pip:
 
 ```bash
-pip install timeseries-shaper
+pip install ts-shape
 ```
 
 ## Documentation
 
-For full documentation, visit GitHub Pages or check out the docstrings in the code.
+For full documentation, visit [GitHub Pages](https://jakobgabriel.github.io/ts-shape/) or check out the docstrings in the code.
 
 ## Contributing
 
diff --git a/docs/insiders/installation.md b/docs/insiders/installation.md
@@ -0,0 +1 @@
+# Installation
diff --git a/docs/summary.md b/docs/summary.md
@@ -0,0 +1,3 @@
+# Package Summary
+
+--8<-- "reference/SUMMARY.md"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,6 +19,7 @@ nav:
   - Changelog: changelog.md
 #  - Credits: credits.md
   - License: license.md
+  - Summary: summary.md
 - Usage:
   - usage/index.md
 # defer to gen-files + literate-nav
@@ -28,7 +29,7 @@ nav:
   - Contributing: contributing.md
 #  - Code of Conduct: code_of_conduct.md
   - Getting started:
-#    - Installation: insiders/installation.md
+    - Installation: insiders/installation.md
     - Development: insiders/development.md
 
 theme:
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,3 @@
 pandas==2.1.0
-#pdoc==14.6.1 # for docs
 scipy==1.13.1
 s3fs==2024.10.0
