@remotion/paths 4.0.176 → 4.0.178

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -24
  2. package/package.json +6 -12
package/README.md CHANGED
@@ -1,24 +1,18 @@
1
- ## @remotion/paths
2
-
3
- A package providing utility functions for dealing with SVG paths. This package consists of code from [`svg-path-properties`](https://www.npmjs.com/package/svg-path-properties) and [`svg-path-reverse`](https://github.com/Pomax/svg-path-reverse#readme) with the following improvements:
4
-
5
- - Functional style APIs
6
- - First class Typescript types
7
- - Documentation with examples
8
- - ESM import style
9
-
10
- No dependencies are needed, meaning this package can be used independently of Remotion.
11
-
12
- ## API
13
-
14
- - [`getLength()`](https://remotion.dev/docs/paths/get-length)
15
- - [`getPointAtLength()`](https://remotion.dev/docs/paths/get-point-at-length)
16
- - [`getTangentAtLength()`](https://remotion.dev/docs/paths/get-tangent-at-length)
17
- - [`reversePath()`](https://remotion.dev/docs/paths/reverse-path)
18
- - [`normalizePath()`](https://remotion.dev/docs/paths/normalize-path)
19
- - [`interpolatePath()`](https://remotion.dev/docs/paths/interpolate-path)
20
- - [`evolvePath()`](https://remotion.dev/docs/paths/evolve-path)
21
-
22
- ## License
23
-
24
- MIT
1
+ # @remotion/paths
2
+
3
+ Utilities for working with SVG paths
4
+
5
+ [![NPM Downloads](https://img.shields.io/npm/dm/@remotion/paths.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/paths?minimal=true)
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install @remotion/paths --save-exact
11
+ ```
12
+
13
+ When installing a Remotion package, make sure to align the version of all `remotion` and `@remotion/*` packages to the same version.
14
+ Remove the `^` character from the version number to use the exact version.
15
+
16
+ ## Usage
17
+
18
+ See the [documentation](https://www.remotion.dev/paths) for more information.
package/package.json CHANGED
@@ -1,24 +1,17 @@
1
1
  {
2
+ "repository": {
3
+ "url": "https://github.com/remotion-dev/remotion/tree/main/packages/paths"
4
+ },
2
5
  "name": "@remotion/paths",
3
- "version": "4.0.176",
4
- "description": "Utility functions for SVG paths",
6
+ "version": "4.0.178",
7
+ "description": "Utilities for working with SVG paths",
5
8
  "main": "dist/index.js",
6
9
  "sideEffects": false,
7
10
  "author": "Jonny Burger <jonny@remotion.dev>",
8
11
  "license": "MIT",
9
- "repository": {
10
- "url": "https://github.com/remotion-dev/remotion"
11
- },
12
12
  "bugs": {
13
13
  "url": "https://github.com/remotion-dev/remotion/issues"
14
14
  },
15
- "devDependencies": {
16
- "@jonny/eslint-config": "3.0.281",
17
- "@types/node": "18.14.6",
18
- "eslint": "8.56.0",
19
- "prettier": "3.2.5",
20
- "prettier-plugin-organize-imports": "3.2.4"
21
- },
22
15
  "keywords": [
23
16
  "svg",
24
17
  "path",
@@ -27,6 +20,7 @@
27
20
  "publishConfig": {
28
21
  "access": "public"
29
22
  },
23
+ "homepage": "https://www.remotion.dev/paths",
30
24
  "scripts": {
31
25
  "formatting": "prettier src --check",
32
26
  "lint": "eslint src --ext ts,tsx",