Skip to content

Commit

Permalink
docs(readme): describe how it works
Browse files Browse the repository at this point in the history
  • Loading branch information
remarkablemark authored Jan 12, 2024
1 parent e54a751 commit 11b93f2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,15 @@ If you're not using `jsxImportSource`, you can set JSX pragma at the top of your
import { jsx } from 'phaser-jsx';
```

## How Does It Work?

This package follows [React](https://react.dev/) conventions like having `createElement` and `jsx-runtime`.

The `render` function renders the objects inside `Phaser.GameObjects.Container`.

> [!IMPORTANT]
> This allows for nesting and for child objects to be positioned relative to its `Container`.
## Release

Release is automated with [Release Please](https://github.com/googleapis/release-please).
Expand Down

0 comments on commit 11b93f2

Please sign in to comment.