Skip to content

Commit 699b8cf

Browse files
committed
Update README
1 parent 3674ff8 commit 699b8cf

1 file changed

Lines changed: 24 additions & 25 deletions

File tree

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,30 @@ JavaScript renderer implementation for the [3D Tiles format](https://github.com/
99

1010
If a tileset or geometry does not load or render properly please make an issue! Example data is needed for adding and testing features. See the [Feature Complete Milestone](https://github.com/NASA-AMMOS/3DTilesRendererJS/milestone/1) for information on which features are not yet implemented.
1111

12+
# Getting Started
13+
14+
## Installation
15+
16+
```
17+
npm install 3d-tiles-renderer --save
18+
```
19+
20+
## API
21+
22+
| Package | Reference |
23+
| --- | --- |
24+
| `3d-tiles-renderer/core` | [API Reference](./src/core/renderer/API.md) |
25+
| `3d-tiles-renderer/three` | [Usage Guide](./USAGE.md) · [API Reference](./src/three/renderer/API.md) |
26+
| `3d-tiles-renderer/babylonjs` | [Usage Guide](./src/babylonjs/renderer/README.md) · [API Reference](./src/babylonjs/renderer/API.md) |
27+
| `3d-tiles-renderer/r3f` | [Usage Guide](./src/r3f/README.md) · [API Reference](./src/r3f/API.md) |
28+
29+
## Plugins
30+
31+
| Package | Reference |
32+
| --- | --- |
33+
| `3d-tiles-renderer/plugins` | [Plugin Guide](./src/three/plugins/README.md) · [API Reference](./src/three/plugins/API.md) |
34+
| `3d-tiles-renderer/core/plugins` | [API Reference](./src/core/plugins/API.md) |
35+
1236
# Examples
1337

1438
The following examples use **Three.js**. Babylon.js demos are also available for [Mars](https://nasa-ammos.github.io/3DTilesRendererJS/babylonjs/mars.html) and [Google Photorealistic Tiles](https://nasa-ammos.github.io/3DTilesRendererJS/babylonjs/googleMapsAerial.html).
@@ -44,31 +68,6 @@ See the [Three.js usage guide](./USAGE.md) or [Babylon.js usage guide](./src/bab
4468

4569
¹ Requires a [Google Tiles API Key](https://developers.google.com/maps/documentation/tile/3d-tiles) or [Cesium Ion API Key](https://cesium.com/platform/cesium-ion/)
4670

47-
48-
# Getting Started
49-
50-
## Installation
51-
52-
```
53-
npm install 3d-tiles-renderer --save
54-
```
55-
56-
## API
57-
58-
| Package | Reference |
59-
| --- | --- |
60-
| `3d-tiles-renderer/core` | [API Reference](./src/core/renderer/API.md) |
61-
| `3d-tiles-renderer/three` | [Usage Guide](./USAGE.md) · [API Reference](./src/three/renderer/API.md) |
62-
| `3d-tiles-renderer/babylonjs` | [Usage Guide](./src/babylonjs/renderer/README.md) · [API Reference](./src/babylonjs/renderer/API.md) |
63-
| `3d-tiles-renderer/r3f` | [Usage Guide](./src/r3f/README.md) · [API Reference](./src/r3f/API.md) |
64-
65-
## Plugins
66-
67-
| Package | Reference |
68-
| --- | --- |
69-
| `3d-tiles-renderer/plugins` | [Plugin Guide](./src/three/plugins/README.md) · [API Reference](./src/three/plugins/API.md) |
70-
| `3d-tiles-renderer/core/plugins` | [API Reference](./src/core/plugins/API.md) |
71-
7271
# LICENSE
7372

7473
The software is available under the [Apache V2.0 license](LICENSE).

0 commit comments

Comments
 (0)