chore(release): v1.0.0 (#7)

CHANGELOG.md

@@ -1,15 +1,12 @@
-Version - Date
-(e.g v0.0.1 - 19 Nov 2021)
-------------
-
-Bug fixes:
-
-* [#PR number](PR or issue link) description.
+v1.0.0 - 2021-12-14
+----------------------
 
 Features:
 
-* [#PR number](PR or issue link) description.
+* [#4](https://github.com/godaddy/sample-size/pull/4) - Add implementation for sample size calculator which supports a single metric calculation.
+* [#6](https://github.com/godaddy/sample-size/pull/6) - Add script to run sample size calculation locally.
 
 Other changes:
 
-* [#PR number](PR or issue link) description.
+* [#1](https://github.com/godaddy/sample-size/pull/1) - Setup the repo with CI using github actions
+* [#3](https://github.com/godaddy/sample-size/pull/3) - Setup release workflow and instructions

README.md

@@ -3,12 +3,40 @@
 This python project is a helper package that uses power analysis to calculate required sample size for any experiment.
 
 ## Script Usage Guide
+
+Sample size script lets you get the sample size estimation easily by providing metric inputs.
+
+### Requirements
+
+Please make sure you have [Python 3](https://www.python.org/downloads/) installed before using the script.
+
+**Verify Python was installed** 
+
+```bash
+python -V # python version should >=3.7.1, <3.11
+```
+
+**Verify pip was installed** 
+```bash
+pip -V 
 ```
+
+### Install the package
+
+```bash
 pip install sample-size
+pip show sample-size # verify package was installed
+```
+
+### Start using the script
+
+`run-sample-size` will promp you questions for you to enter the input it needs
+
+```bash
 run-sample-size
 ```
 
-## Script Constraints
+### Script Constraints
 * This package supports 
   * Single metric per calculator for now
   * Metric types: Boolean, Numeric, and Ratio

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sample-size"
-version = "0.0.1a1"
+version = "1.0.0"
 description = "A python module implementing power analysis to estimate sample size"
 authors = []
 include = ["CHANGELOG.md", "README.md"]
@@ -72,7 +72,7 @@ testpaths = ["tests"]
 
 [tool.coverage.run]
 branch = true
-source = ["sample_size", "scripts"]
+source = ["sample_size"]
 
 [tool.coverage.report]
 exclude_lines = [