lunchboxjs 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
Lunchbox 2 lets you write [ThreeJS](https://threejs.org/) scenes using [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components). You can use it in any (or no) framework.
|
|
2
|
+
|
|
3
|
+
```html
|
|
4
|
+
<three-lunchbox>
|
|
5
|
+
<three-mesh position-z="-5">
|
|
6
|
+
<torus-knot-geometry></torus-knot-geometry>
|
|
7
|
+
<mesh-normal-material></mesh-normal-material>
|
|
8
|
+
</three-mesh>
|
|
9
|
+
</three-lunchbox>
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Full Docs
|
|
13
|
+
|
|
14
|
+
[docs.lunchboxjs.com](https://docs.lunchboxjs.com/)
|
|
15
|
+
|
|
16
|
+
## About
|
|
17
|
+
|
|
18
|
+
Lunchbox started as a Vue + ThreeJS custom renderer, but from version 2 on will be focused on web components built into browsers.
|
|
19
|
+
|
|
20
|
+
## Local Dev
|
|
21
|
+
|
|
22
|
+
`npm install`, then `npm run dev` to run dev server. From there, edit source code in the LunchboxJS package's `/src/...` and examples in `/index.html/...` to build and test features.
|
|
23
|
+
|
|
24
|
+
`npm run test` to run headless tests, `npm run cy:open` to open Cypress test suites.
|
|
25
|
+
|
|
26
|
+
`npm run docs:dev` to run docs locally.
|
|
27
|
+
|
|
28
|
+
## Publishing
|
|
29
|
+
|
|
30
|
+
`npm run test` to make sure all tests pass, then `npm run publish`.
|