Skip to content

Commit 00072a5

Browse files
committed
docs: update README with package links and new domain URLs
1 parent 899ec57 commit 00072a5

File tree

1 file changed

+13
-36
lines changed

1 file changed

+13
-36
lines changed

README.md

Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,44 +23,21 @@ Here, you'll find the source code for the entire `angular-three` ecosystem, the
2323

2424
## Documentation
2525

26-
The documentation is available at [angularthree.netlify.app](https://angularthree.netlify.app).
26+
The documentation is available at [angularthree.org](https://angularthree.org).
2727

2828
## Examples
2929

30-
The examples are available at [angularthreedemo.netlify.app](https://angularthreedemo.netlify.app).
30+
The examples are available at [demo.angularthree.org](https://demo.angularthree.org).
3131

32-
## Features
32+
## Packages
3333

34-
### Pierced Props
35-
36-
Angular Three supports "pierced" property bindings that allow you to set individual components of vector/math properties:
37-
38-
```html
39-
<!-- Instead of setting the entire rotation vector -->
40-
<ngt-mesh [rotation]="[-Math.PI / 2, 0, 0]" />
41-
42-
<!-- You can set individual components -->
43-
<ngt-mesh [rotation.x]="-Math.PI / 2" />
44-
```
45-
46-
This also works for nested properties like shadow configuration on lights:
47-
48-
```html
49-
<ngt-directional-light
50-
[castShadow]="true"
51-
[shadow.mapSize.width]="2048"
52-
[shadow.mapSize.height]="2048"
53-
[shadow.camera.near]="0.5"
54-
[shadow.camera.far]="500"
55-
[shadow.camera.left]="-10"
56-
[shadow.camera.right]="10"
57-
/>
58-
```
59-
60-
Supported pierced properties include:
61-
62-
- **Vector2/3/4**: `x`, `y`, `z`, `w`
63-
- **Euler** (rotation): `x`, `y`, `z`
64-
- **Quaternion**: `x`, `y`, `z`, `w`
65-
- **Color**: `r`, `g`, `b`
66-
- **Shadow** (on lights): `shadow.intensity`, `shadow.bias`, `shadow.mapSize.width`, `shadow.camera.near`, etc.
34+
| Package | Description |
35+
| --------------------------------------------------------------- | -------------------------------------------------- |
36+
| [angular-three](./libs/core/README.md) | Core library - Angular renderer for Three.js |
37+
| [angular-three-soba](./libs/soba/README.md) | Helpers, abstractions, and ready-to-use components |
38+
| [angular-three-cannon](./libs/cannon/README.md) | Cannon.js physics integration |
39+
| [angular-three-rapier](./libs/rapier/README.md) | Rapier physics integration |
40+
| [angular-three-postprocessing](./libs/postprocessing/README.md) | Post-processing effects |
41+
| [angular-three-theatre](./libs/theatre/README.md) | Theatre.js animation integration |
42+
| [angular-three-tweakpane](./libs/tweakpane/README.md) | Tweakpane debug controls |
43+
| [angular-three-plugin](./libs/plugin/README.md) | Nx plugin with generators and utilities |

0 commit comments

Comments
 (0)