Skip to content

Commit 48f70c5

Browse files
committed
docs(general): improve getting started flow
1 parent f9f53ad commit 48f70c5

File tree

3 files changed

+7020
-5
lines changed

3 files changed

+7020
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22
<a href="https://www.reactylon.com/docs">
3-
<img height="250" width="250" alt="Reactylon" src="https://www.reactylon.com/logo.svg">
3+
<img height="250" width="250" alt="Reactylon" src="./assets/logo.svg">
44
</a>
55
<h1>Reactylon</h1>
66
</div>
@@ -17,7 +17,27 @@
1717
<br />
1818
<br />
1919

20-
Welcome to **Reactylon**, a powerful multiplatform framework built on top of Babylon.js and React, designed to create interactive and immersive XR experiences. It allows developers to create full immersive experience in a declarative way, unlocking the full potential of React’s component-based architecture for interactive 3D applications.
20+
Welcome to **Reactylon**, a powerful multiplatform framework built on top of Babylon.js and React. It lets you build interactive 3D and XR applications using a fully declarative, component-based model that integrates seamlessly with React's architecture.
21+
22+
## Getting Started
23+
24+
### Installation
25+
26+
The easiest way to get started is with the official `create-reactylon-app` CLI.
27+
28+
It bootstraps a full React 19 project with a preconfigured Babylon.js engine, physics support, and a starter scene. No setup required.
29+
30+
<p><img width="898" alt="Create Reactylon App" src="./assets/create-reactylon-app.gif"></p>
31+
32+
```bash
33+
npx create-reactylon-app my-app
34+
```
35+
<br/>
36+
37+
For a complete walkthrough, see the [Getting Started guide](https://www.reactylon.com/docs/getting-started).
38+
39+
### Documentation
40+
You can explore the interactive Reactylon documentation on [reactylon.com](https://www.reactylon.com/docs), featuring **125+ live sandbox examples** you can open and edit directly in your browser.
2141

2242
## Key Features
2343
- **Declarative Syntax for Babylon.js**: Write 3D scenes in JSX, leveraging the power of declarative UI that React developers love, with seamless integration into the Babylon.js rendering engine.
@@ -34,10 +54,14 @@ Welcome to **Reactylon**, a powerful multiplatform framework built on top of Bab
3454

3555
- **Enhanced React Integration**: Deep React integration allows for easy state management, component composition, and hooks, ensuring a seamless development experience that leverages React’s full power in 3D rendering.
3656

37-
## Documentation
38-
You can find the interactive Reactylon documentation on [reactylon.com](https://www.reactylon.com/docs).
57+
## When should you use Reactylon?
58+
59+
Use Reactylon if:
3960

40-
Check out the [Getting Started](https://www.reactylon.com/docs/getting-started) page for a quick overview.
61+
- You want to build **3D or XR experiences** using React and JSX instead of imperative Babylon.js code.
62+
- You need **cross-platform** support (web, mobile, VR/AR/MR headsets) from a single codebase.
63+
- You care about **type safety, tree-shaking and performance** out of the box.
64+
- You prefer an **opinionated** layer that manages scene graph, resource disposal, and hierarchy for you.
4165

4266
## Contributing
4367
We welcome contributions to improve and expand this project! To get started, please read [Contributing](CONTRIBUTING.md). This document provides all the necessary steps and best practices for submitting contributions.

assets/create-reactylon-app.gif

397 KB
Loading

0 commit comments

Comments
 (0)