@motion.page/sdk 0.1.5 → 1.0.0
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.
- package/README.md +6 -8
- package/dist/index.cjs +4 -4
- package/dist/index.cjs.map +2 -2
- package/package.json +1 -5
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ A high-performance animation SDK with a declarative API. Scroll-triggered animat
|
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@motion.page/sdk)
|
|
6
6
|
[](https://bundlephobia.com/package/@motion.page/sdk)
|
|
7
|
-
[](
|
|
7
|
+
[](#license)
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
@@ -43,8 +43,6 @@ yarn add @motion.page/sdk
|
|
|
43
43
|
pnpm add @motion.page/sdk
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
📖 Full documentation and interactive examples: [motion.page](https://motion.page)
|
|
47
|
-
|
|
48
46
|
> **⚠️ Browser-only:** This SDK requires a browser environment (`document`, `window`). In SSR frameworks (Next.js, Nuxt, Astro), wrap SDK calls in `useEffect`, `onMounted`, or client-side scripts.
|
|
49
47
|
|
|
50
48
|
For direct browser use without a bundler, see [Browser Build](#browser-build).
|
|
@@ -1214,14 +1212,14 @@ import { Types } from '@motion.page/sdk';
|
|
|
1214
1212
|
|
|
1215
1213
|
## Browser Build
|
|
1216
1214
|
|
|
1217
|
-
### Browser Build (IIFE)
|
|
1218
|
-
|
|
1219
1215
|
An IIFE build script is included but not part of the default build output. To generate a browser bundle:
|
|
1220
1216
|
|
|
1221
1217
|
```bash
|
|
1222
1218
|
bun run packages/sdk/scripts/build-iife.ts
|
|
1223
1219
|
```
|
|
1224
1220
|
|
|
1221
|
+
> **Note:** This script is available in the [source repository](https://motion.page) only. It is not included in the npm package.
|
|
1222
|
+
|
|
1225
1223
|
This creates a self-contained script that exposes `window.Motion` and `window.MotionTimeline`:
|
|
1226
1224
|
|
|
1227
1225
|
```html
|
|
@@ -1253,12 +1251,12 @@ Modern evergreen browsers:
|
|
|
1253
1251
|
|
|
1254
1252
|
## License
|
|
1255
1253
|
|
|
1256
|
-
**FSL-1.1-Apache-2.0** — [Functional Source License, Version 1.1, Apache 2.0 Future License](
|
|
1254
|
+
**FSL-1.1-Apache-2.0** — [Functional Source License, Version 1.1, Apache 2.0 Future License](#license)
|
|
1257
1255
|
|
|
1258
|
-
**TL;DR:** Free for everyone. Use it in your websites, apps, SaaS products, client projects — commercial or not.
|
|
1256
|
+
**TL;DR:** Free for everyone. Use it in your websites, apps, SaaS products, client projects — commercial or not. One restriction: you can't use it to build a competing animation builder tool.
|
|
1259
1257
|
|
|
1260
1258
|
**The one exception:** You cannot use this SDK to build a product that competes with Motion.page (e.g., a no-code animation builder, visual animation editor, or similar tool). If you're building something like that, [contact us](mailto:hello@motion.page) for an enterprise license.
|
|
1261
1259
|
|
|
1262
1260
|
After 2 years from each release, the code converts to the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license with no restrictions at all.
|
|
1263
1261
|
|
|
1264
|
-
See [LICENSE](
|
|
1262
|
+
See [LICENSE](#license) for the full legal text.
|