diff --git a/README.md b/README.md index a47c021e0..8a3c5b239 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,30 @@ -# @tresjs/core ▲ ■ ● +![repo-banner](/public/repo-banner.png) + +
+ +# TresJS `@tresjs/core` > Declarative ThreeJS using Vue Components - 💡 Build 3D scene as they were Vue components - ⚡️ Powered by Vite -- 🥰 It brings all the updated features of ThreeJS right awayregardless the version +- 🥰 It brings all the updated features of ThreeJS right away regardless the version - 🦾 Fully Typed -Tres (Spanish word for "three", pronounced `/tres/` ) is a way of creating ThreeJS scenes with Vue components in a declarative fashion. Think of it as a [React-three-fiber](https://docs.pmnd.rs/react-three-fiber) or [Lunchbox](https://github.com/breakfast-studio/lunchboxjs) but without the need of a [custom Vue3 Renderer](https://vuejs.org/api/custom-renderer.html). +Tres (Spanish word for "three", pronounced `/tres/` ) is a way of creating ThreeJS scenes with Vue components in a declarative fashion. + +It's build on-top of a [Vue Custom Renderer](https://vuejs.org/api/custom-renderer.html#createrenderer) and it's powered by Vite. + +The goal is to provide the Vue's community an easy way of building 3D scenes with Vue, always up to date with the latest ThreeJS features and with 0-to-none mantainance. + +## Installation + +```bash +pnpm install @tresjs/core@beta three +``` ## Docs diff --git a/public/repo-banner.png b/public/repo-banner.png new file mode 100644 index 000000000..b1a8e1198 Binary files /dev/null and b/public/repo-banner.png differ