Mathform NPM | npm.io

About The Project

Mathform is a collection of mathematical formulas and various algorithms that I have been using over the time. The purpose of this repo is NOT to provide an optimized math library as the scope of the modules and the features is not defined.

Getting Started

Installation

Clone the repo

git clone https://github.com/adiama/mathform.git

Install NPM packages
```
npm install
```

Usage

cdn

<script src="https://combinatronics.com/adiama/mathform/main/dist/mathform.umd.js"></script>

<script type="text/javascript">
    console.log(mathform.geometry.Circle.area(5));
</script>

es5

const mathform = require('mathform');
console.log(mathform.geometry.Circle.area(5));

es6

import * as mathform from "mathform";
console.log(mathform.geometry.Circle.area(5));

or import specific modules

import { helpers, geometry } from "mathform";
console.log(helpers.format(geometry.Circle.area(5)));

For more examples, please refer to the Documentation

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!