From 890b309e19fd592442b275a5a2a55e568088304a Mon Sep 17 00:00:00 2001 From: Viktoras Bezaras Date: Sun, 26 Feb 2023 21:49:02 +0100 Subject: [PATCH] Updated readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8921df0..e092726 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A library to estimate 1-Rep-Max using different formulas. +More information about [One-repetition maximum](https://en.wikipedia.org/wiki/One-repetition_maximum) (Wikipedia). + ## Installation ```bash @@ -15,6 +17,18 @@ import { RepCalculator } from 'repmax-calc' const calc = new RepCalculator() -calc.getOneRepMaxAverage(80, 6) +// Calculate 1RM with a specific formula calc.getOneRepMax(Formula.Brzycki, 100, 8) + +// Calculate 1RM as an average of all used formulas +calc.getOneRepMaxAverage(100, 8) + +// Get the highest estimate of all used formula +calc.getOneRepMaxHigh(100, 8) + +// Get the lowest estimate of all used formula +calc.getOneRepMaxLow(100, 8) + +// Get all formulas results +calc.getOneRepMaxAll(100, 8) ```