Sports & Health Calculators

An open-source collection of calculators and computations for various sports and health-related metrics. Proudly presented by CoachRec.

Table of Contents

1. Introduction
2. Installation
3. Usage
4. Available Calculators
5. Contributing
6. License
7. Contact

Introduction

Whether you're developing an application for athletes, fitness enthusiasts, or anyone keen on tracking their health metrics, our library is here to help you

Installation

To install the package from NPM, use the following command:

npm install @coachrec/sports-health-calculators

Usage

Once installed, you can import the required calculators as follows:

const { calculateBMIMetric, calculateBMIImperial } = require('@coachrec/sports-health-calculators');

Available Calculators

• BMI
  • Metric (calculateBMIMetric)
  • Imperial (calculateBMIImperial)

More calculators will be added in future versions. If you have a suggestion or request, please raise an issue.

Roadmap

In progress: will set up a table here for the future calculators

Contributing

We welcome contributions from the community. If you'd like to add a calculator or improve an existing one, please follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name.
3. Make your changes and commit them with a clear message.
4. Create a pull request detailing the changes you made.

Please ensure your changes do not break existing functionality. Including tests with your pull request is highly encouraged.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any queries or feedback, please raise an issue on the GitHub repository or contact CoachRec through our official website.