Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
viktoras25 committed Feb 26, 2023
1 parent dc29791 commit 890b309
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
```

0 comments on commit 890b309

Please sign in to comment.