1.0.0 • Published 2 years ago

@pbuk/rec-math v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

RecMath

Recreational mathemetics including games and puzzle solvers.

Getting Started: in a web page

Current major browsers are supported but not Internet Explorer (edit targets in rollup.config.js and run npm run build to change this).

Load the script from the CDN:

<script src="https://cdn.jsdelivr.net/npm/@pbuk/rec-math@1"></script>

The module is exported as RecMath:

<script>
  document.write(RecMath.version);
</script>

Getting Started: in Node.js

Node >= 12 is currently supported in the distributed modules.

Install from npm:

$ npm i @pbuk/rec-math

Require CommonJS module:

// Default should work...
const RecMath = require('rec-math');
// ...or specify CommonJS module.
const RecMath = require('rec-math/dist/cjs');

or import as an ES6 module:

// Default should work...
import RecMath from 'rec-math';
// ...or specify ES6 module.
import RecMath from 'rec-math/dist/esm';

Documentation

Development

$ # Run unit tests.
$ npm run test:unit
$
$ # Build and run all tests.
$ npm run build
$ npm run test

Contributing

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Acknowledgements