Skip to content

Commit

Permalink
add a warning
Browse files Browse the repository at this point in the history
  • Loading branch information
lgabs committed Jul 14, 2024
1 parent eaa08ca commit 65a4a10
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ Janus is a simple and easy A/B Test Calculator that allows you to run A/B tests

It's developed mainly for website experiments. While many calculators only account for conversion analysis and consider only two variants, Janus allows multivariant tests and measure _Conversion_, _Averge Ticket_ and _Average Revenue Per User (ARPU)_ over variants, i.e, typical metrics for tests in marketplaces.

The engine name is an analogy to _Janus_, the god of changes and transitions.

The engine name is an analogy to _Janus_, the god of changes and transitions.

## Installation

Expand Down Expand Up @@ -51,6 +50,10 @@ My plan is to build a website to showcase the Janus library and to provide a sim
- build a frontend (JavaScript maybe)
- deploy the website

> **Warning**
> The distributed package is from this branch, which will be merged to `main` in the first release of this project. The `main` branch uses another previous approach for the calculations (yet correct), and has a streamlit app to showcase the library.
> In this branch, however, we'll change the whole project towards not only a library, but also for a full stack application, with frontend and backend.

## References
* [What is A/B Testing](https://en.wikipedia.org/wiki/A/B_testing)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "janus-web-ab-testing"
version = "0.1.3"
version = "0.1.4"
description = "Janus, an A/B Test Framework."
authors = ["Luan Fernandes <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit 65a4a10

Please sign in to comment.