@thi.ng/math - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

AUTHORS.md

@@ -1,7 +0,7 @@
-## Maintainer
+### Maintainer
 
 -   Karsten Schmidt (@postspectacular)
 
-## Contributors
+### Contributors
 
 -   @nkint

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [1.5.1](https://github.com/thi-ng/umbrella/compare/@thi.ng/math@[e-mail]/math@1.5.1) (2019-11-30)
+
+**Note:** Version bump only for package @thi.ng/math
+
+
+
+
+
 # [1.5.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/math@[e-mail]/math@1.5.0) (2019-11-09)
@@ -8,0 +16,0 @@

package.json

 {
     "name": "@thi.ng/math",
-    "version": "1.5.0",
+    "version": "1.5.1",
     "description": "Assorted common math functions & utilities",
@@ -21,15 +21,18 @@ "module": "./index.js",
         "build:test": "rimraf build && tsc -p test/tsconfig.json",
-        "test": "yarn build:test && mocha build/test/*.js",
-        "cover": "yarn build:test && nyc mocha build/test/*.js && nyc report --reporter=lcov",
+        "test": "mocha test",
+        "cover": "nyc mocha test && nyc report --reporter=lcov",
         "clean": "rimraf *.js *.d.ts .nyc_output build coverage doc lib",
-        "doc": "node_modules/.bin/typedoc --mode modules --out doc --ignoreCompilerErrors src",
+        "doc:readme": "../../scripts/generate-readme",
+        "doc": "node_modules/.bin/typedoc --mode modules --out doc src",
         "pub": "yarn build:release && yarn publish --access public"
     },
     "devDependencies": {
+        "@istanbuljs/nyc-config-typescript": "^0.1.3",
         "@types/mocha": "^5.2.6",
-        "@types/node": "^12.6.3",
-        "mocha": "^6.1.4",
+        "@types/node": "^12.12.11",
+        "mocha": "^6.2.2",
         "nyc": "^14.0.0",
-        "typedoc": "^0.15.0",
-        "typescript": "^3.6.4"
+        "ts-node": "^8.5.2",
+        "typedoc": "^0.15.2",
+        "typescript": "^3.7.2"
     },
@@ -49,3 +52,3 @@ "keywords": [
     "sideEffects": false,
-    "gitHead": "97add769f24aa32a1a5e13c5c941605e1b9eb569"
+    "gitHead": "36c4d9e967bd80ccdbfa0f4a42f594080f95f105"
 }

README.md

@@ -0,4 +1,6 @@
+<!-- This file is generated - DO NOT EDIT! -->
+
 # @thi.ng/math
 
-[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/math.svg)](https://www.npmjs.com/package/@thi.ng/math)
+[![npm version](https://img.shields.io/npm/v/@thi.ng/math.svg)](https://www.npmjs.com/package/@thi.ng/math)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/math.svg)
@@ -10,13 +12,13 @@ [![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
 
-<!-- TOC depthFrom:2 depthTo:3 -->
-
 - [About](#about)
+  - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
+- [API](#api)
 - [Authors](#authors)
+  - [Maintainer](#maintainer)
+  - [Contributors](#contributors)
 - [License](#license)
 
-<!-- /TOC -->
-
 ## About
@@ -26,2 +28,10 @@
 
+Partially ported from Clojure version of
+[thi.ng/math](https://github.com/thi-ng/math) and
+[thi.ng/vexed-generation](https://github.com/thi-ng/vexed-generation).
+
+### Status
+
+**STABLE** - used in production
+
 ## Installation
@@ -35,16 +45,72 @@
 
-None.
+None
 
 ## Usage examples
 
-```ts
-import * as m from "@thi.ng/math";
-```
+Several demos in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/master/examples)
+directory are using this package.
 
+A selection:
+
+### crypto-chart <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/crypto-chart.png)
+
+Basic crypto-currency candle chart with multiple moving averages plots
+
+[Live demo](https://demo.thi.ng/umbrella/crypto-chart/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/crypto-chart)
+
+### hdom-canvas-draw <!-- NOTOC -->
+
+Interactive @thi.ng/hdom-canvas pattern drawing demo using transducers
+
+[Live demo](https://demo.thi.ng/umbrella/hdom-canvas-draw/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/hdom-canvas-draw)
+
+### iso-plasma <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/geom/geom-isoline.png)
+
+Animated sine plasma effect visualized using contour lines
+
+[Live demo](https://demo.thi.ng/umbrella/iso-plasma/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/iso-plasma)
+
+### mandelbrot <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/mandelbrot.jpg)
+
+Worker based, interactive Mandelbrot visualization
+
+[Live demo](https://demo.thi.ng/umbrella/mandelbrot/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/mandelbrot)
+
+### scenegraph <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/scenegraph.png)
+
+[Live demo](https://demo.thi.ng/umbrella/scenegraph/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/scenegraph)
+
+### scenegraph-image <!-- NOTOC -->
+
+![screenshot](https://raw.githubusercontent.com/thi-ng/umbrella/master/assets/examples/scenegraph-image.png)
+
+[Live demo](https://demo.thi.ng/umbrella/scenegraph-image/) | [Source](https://github.com/thi-ng/umbrella/tree/master/examples/scenegraph-image)
+
+## API
+
+[Generated API docs](https://docs.thi.ng/umbrella/math/)
+
+TODO
+
 ## Authors
 
-- Karsten Schmidt
+### Maintainer
 
+-   Karsten Schmidt ([@postspectacular](https://github.com/postspectacular))
+
+### Contributors
+
+-   [@nkint](https://github.com/nkint)
+
 ## License
 
-&copy; 2018 Karsten Schmidt // Apache Software License 2.0
+&copy; 2016 - 2019 Karsten Schmidt // Apache Software License 2.0

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

166637

increased by7.93%

Number of package files

58

increased by41.46%

Number of lines in readme file

114

increased by137.5%

Worsened metrics

Dev dependency count

8

increased by33.33%

No dependency changes