Update readme, re-enable restriction to only publish on main, increme…

…nt changelog
getyourguide · Nov 24, 2023 · 248920a · 248920a
1 parent f48d25f
commit 248920a
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -30,7 +30,7 @@ jobs:
           pytest .
           rm -rf .venv
       - name: Publish to PYPI
-#        if: github.ref_name == 'main'
+        if: github.ref_name == 'main'
         run: |
           pip install poetry
           poetry config virtualenvs.create false

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,2 +1,5 @@
+## Version 0.1.1
+- Fix import example in README
+
 ## Version 0.1.0
 - Initial release
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ customers / number of visitors) by at least 1%.
 You initialize Basemath using the following Python code:
 
 ```python
-import basemath_analysis as bm
+import basemath_analysis.basemath as bm
 bm_test = bm.BaseMathsTest(cr_A, mde, alpha, beta, seed="experiment_name")
 ```
 The parameters are as follows:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "basemath-analysis"
-version = "0.1.0"
+version = "0.1.1"
 description = "A library for BaseMath's test, a novel Group Sequential Testing approach that enables the user to stop early."
 authors = ["Data Products GYG <[email protected]>"]
 license = "Apache License 2.0"