From 7e51db3794acadcb17f28365fbf46df86b6b88fb Mon Sep 17 00:00:00 2001 From: alvarosabu Date: Wed, 19 Apr 2023 17:30:20 +0200 Subject: [PATCH] docs: updated docs --- README.md | 23 ++++++++++++++++++++--- public/repo-banner.png | Bin 0 -> 4653 bytes 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 public/repo-banner.png 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) + +

+ npm package + discord chat +

+ +# 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 0000000000000000000000000000000000000000..b1a8e11986f02c05a1b76897e0872478c357aa7f GIT binary patch literal 4653 zcmeHL`8%809zUt2C=JR4vC~nEZM4-|LsfNVimR5HqNujC#uVuip^1yqT1uy5R9j0Y zqZlKts!FZ3Pf^hgwTnwEjU^H(67G4EdFCIu&;6}=o;>HxIq&!TJ?FEW_q@5`;dVq$ zMok6)Aa~T&*%JVXLI6--NlC(8I{4qcVBR#? zft}h8y*T?7G-<)gN_Y-qBWEmgOm=@)V*`0&fiTy#eX?R>Ct_inexa3%Dy^ukFW*;I z3+l-monswiap%Y$?p8kyUq4>#)^=?NrZcc|YH6Y+>f=DgfyfsQxYFjxkbS2F_2rBA z$}IRSZuuDP`7^GdsEA!wO;fK34dkpk_>)ot#lX{B(BbCO**vnEua!dsYf(9;ck9wj z1+92-%h|^&$21@n6Bzd|LVnQVX#Fy~%Phy@?#RBnI>i=aW4|%Vl6tj$YU#)4Rzx(( zgoswxxT-ah`UU_KZMc!d&2dt+S~Fb=%sg$|mNO}6E_)bH&sMnmGF3`2SN7=FvF?ZI zufmH%BA2&{(LF;y_}|=oP)s2&<-UHDvkerM-d_YDUCEa|)W&SiEh}3dxJuUKnGNrH z*J86+r)R&2i_$pB|1+P!xDg~%P0dVLnYZANXQ)sM(k^1lEC{^Xsbbpo1&8Q5z9a}! zgIk#PGit$=-&DTjHwHFhwl=f%P{$^3{A{Q+v4$}SiQKHJ3ui_sVfqXFNu+tB^}kkL z2a=2cxci$H02(~VR43g{z@DxmY)umZ%O`2d2@1ePCaIiQ34-H z0NgIPv*MU6&U(ynX<(!8$wOi$UjB9kYd&%8NoLoKpH*Voh1O~G=03^LMl1lA3?N>4 zKCMiKfNA5+k0nJ{k%DFJ9E;)d6ECy|am!0;8DH0as;o(t1asfP&DlD2^i}&h&}8D`iL53Vhm`^j{QeBUUfpSr>*q@F4c}&Bf0y5ou>byu|pgRp}^`c83cjZ80 zl1B(Oydq}W@3kSej51Er1z`FxQaZRgWxIies}$Eec_3p!z{5jYRZgCi2JtaS_P#DP z&HJs|I`4YhPso}!CkuD^q{9=vd^7Ei9`RT9_lVo3? z1Ui;luMB`UGLgRA{-tq!N$FsF$+F@^2k1vn_@w^>F#=v2}(&ZZ~4>;zZmi2$4y&b(yu zEp`%8bGNToJ8iy#GZMuoKg3!wi)WO|$*{oT%&zZ!>_4K)k27FG7g<3;!6ZIB@+EiGBM{ z7`qLCh~2{9$-*My(`Ta$0r*-PhEeuj6^1>IC8l+u0L~7{MS03vkGb#YG_X5%Rl-KE zPYirOaI+W`;WnW0+uY8zgD9YkD9j~nNW=|>&`&r*B)I{c1ah~+AfM9?h5LBN>PNgp zy;!{fy&d58LuyLupY0SOJ8 zKdz(gHRJx>b_Pk31c`a)<0~S@a$w72?TfwD{XA!B;Guwwmz&zxTl8q_bU%a}?D#4% zh5sXnKaVWWicp)ACI9fa zzavlcfLg$NGKV%F3W7`_+(8Sn=uuT@xx8AJ$N3K}?4~Lx{A7wz8f&uKumNi!Ud$ZhTe_1W}QURDTC|y0*@D#c`=2 zQ3nU91m1J01sI6P5+6c{+z$i4iCvAb`}Q?MY9x^Orj`z|g#f?sSJ52SKt|KPWo7hk zXx$`5P00ZdF?bp`$K;O=AY+md>AjRs{+pqLm1Y3U;UJDip@hgQ5DwL+dz^S^J3V`d zkRB|SjTh8y$SO9=+Gq4a6&*RQ9Fi!YnB9QoSO}j*vgm1ZS1C)i!!xy;v$3zR3q$w| zs`(p7PD+7zYelHhP8H4WGgN?^8Yhq7rFO~)G*RaE&wIQ2<+*_R?*7t zk^GsKKne4E^ij_RtvKuRr8J^F+i94~_3iA6fZ32uqLUvzc_M3`k!;~KpiFr@MCK1w zEYY|8PO9}gDdcM%v|qQZ_i0#@1-;@s;A_Uk=F$4tL>sR4yY<7s&irh?3&dyKVF$<8~)=5raFGk053&^f`}_6%$j#+c;uT`_O`H7%TT zBcn>CE>>64cT`hg%_GxOyXK*e{Vv$MtOZZaOw$P@W9e^`yhS-Ry} zD`QOkr8Wz%_jKIUFm}+dxn!3-&m?Ubnih36Ua9=FIfLJNGnO)?yC0*MKxs5J{j;la z@r^17Q-vtNPrQ-Y!fFtQ1qfF%>*fU^st*V)hQ_9 EzYXliQvd(} literal 0 HcmV?d00001