edited Readme + added .gitignore

nmusmeci · Sep 4, 2020 · 4fe398b · 4fe398b
1 parent 9a81521
commit 4fe398b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+__pycache__/
+.vscode/
+.pytest_cache/
+.DS_Store
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
 # Bayesian A/B and Multivariate Testing
-Functions for Bayesian A/B and Multivariate testing
+Python library containing a couple of functions for Bayesian A/B and Multivariate testing.
+It can be used to:
+
+1. Run a Bayesian analysis on an AB/multivariate test that you have run, returning also a Bayesian credible intervals for the relative uplift;
+
+2. Calculate the minimum sample size required for a Bayesian AB/multivariate test, useful for designing future tests
+
+The library is especially useful when doing repeated tests (as it avoids the multiple testing bias) and when you want to incorporate knowledge/results coming from previous tests.
diff --git a/src/.DS_Store b/src/.DS_Store