@vx/point - npm Package Compare versions

Comparing version 0.0.108 to 0.0.109

package.json

 {
   "name": "@vx/point",
-  "version": "0.0.108",
+  "version": "0.0.109",
   "description": "vx point",
@@ -5,0 +5,0 @@ "main": "build/index.js",

Readme.md

 # @vx/point
 
+A simple class to represent an x, y coordinate.
+
+## Example Usage
+
+```js
+import Point from '@vx/point';
+
+let point  = new Point({x: 2, y: 3});
+let {x, y} = point.value()   // Get the cords from the point
+let array  = point.toArray() // Convert point to array
+```
+
+## Methods
+
+### `point.value()`
+
+Returns an `{x, y}` object with the x and y coordinates.
+
+### `point.toArray()`
+
+Returns the coordinates as an array `[x, y]`.
+
 ## vx packages
@@ -4,0 +26,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

3244

increased by15.08%

Number of lines in readme file

39

increased by129.41%

No dependency changes