Skip to content

Commit 33d375b

Browse files
committed
Update README
1 parent 3b7dc2f commit 33d375b

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,34 @@
22

33
This package adds a [three.js](https://github.com/mrdoob/three.js) GLTFLoader plugin for [KHR_animation_pointer](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_animation_pointer) support.
44

5+
### Usage
6+
7+
Install the package:
8+
`npm i @needle-tools/three-animation-pointer`
9+
10+
11+
Register the plugin on your GLTFLoader:
12+
13+
```js
14+
import { GLTFAnimationPointerExtension } from "@needle-tools/three-animation-pointer"
15+
16+
const loader = new GLTFLoader();
17+
loader.register(p => {
18+
return new GLTFAnimationPointerExtension(p);
19+
}
20+
```
21+
522
## Links
623
7-
- [three.js PR #24108](https://github.com/mrdoob/three.js/pull/24108)
24+
- [Khronos KHR_animation_pointer spec](https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_animation_pointer)
25+
- [three.js repository PR #24108](https://github.com/mrdoob/three.js/pull/24108)
26+
27+
28+
29+
# Contact ✒️
30+
<b>[🌵 Needle](https://needle.tools)</b> •
31+
[Github](https://github.com/needle-tools) •
32+
[Twitter](https://twitter.com/NeedleTools) •
33+
[Discord](https://discord.needle.tools) •
34+
[Forum](https://forum.needle.tools) •
35+
[Youtube](https://www.youtube.com/@needle-tools)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@needle-tools/three-animation-pointer",
3-
"version": "1.0.0-alpha",
3+
"version": "1.0.0-beta",
44
"description": "KHR_animation_pointer support for three.js",
55
"type": "module",
66
"main": "src/index.js",

0 commit comments

Comments
 (0)