Merge branch 'main' into develop

codecentric-oss · Oct 18, 2023 · de2bc1f · de2bc1f
2 parents 98f25df + 5d2d205
commit de2bc1f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 <!--next-version-placeholder-->
 
+## v0.8.2 (2023-10-09)
+
+### Fix
+
+* Add installation info to main documentation ([#84](https://github.com/codecentric-oss/niceml/issues/84)) ([`10e60db`](https://github.com/codecentric-oss/niceml/commit/10e60dbc999e2e396a223d2bbc81f4329a807264))
+* Add installation info to main documentation ([`b2f8c10`](https://github.com/codecentric-oss/niceml/commit/b2f8c10f1c0ab4a7e95ac08092f585f2f6a9ba46))
+
 ## v0.8.1 (2023-09-26)
 
 ### Fix

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -55,7 +55,7 @@ To add niceML as a dependency to your project, use the following
 command:
 
 ```bash
-poetry add niceML
+poetry add niceml
 ```
 
 This will automatically resolve and install the latest compatible

diff --git a/docs/index.md b/docs/index.md
@@ -25,3 +25,12 @@ The documentation of **niceML** is separated into four paths:
 
 Quickly find what you're looking for depending on
 your use case by looking at the provided pages.
+
+## Installation
+
+```bash
+poetry add niceml
+```
+
+For a detailed installation guide, have a look at the [Getting Started Tutorial](
+    getting-started.md#installation).
diff --git a/niceml/__init__.py b/niceml/__init__.py
@@ -1 +1 @@
-__version__ = "0.8.1"
+__version__ = "0.8.2"
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "niceml"
-version = "0.8.1"
+version = "0.8.2"
 description = "Welcome to niceML 🍦, a Python-based MLOps framework that uses TensorFlow and Dagster. This framework streamlines the development, and maintenance of machine learning models, providing an end-to-end solution for building efficient and scalable pipelines."
 authors = [
     "Denis Stalz-John <[email protected]>",