Skip to content

Commit

Permalink
update package, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SaFrMo committed Jul 10, 2024
1 parent c053068 commit f573ade
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions packages/lunchboxjs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
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.

```html
<three-lunchbox>
<three-mesh position-z="-5">
<torus-knot-geometry></torus-knot-geometry>
<mesh-normal-material></mesh-normal-material>
</three-mesh>
</three-lunchbox>
```

## Full Docs

[docs.lunchboxjs.com](https://docs.lunchboxjs.com/)

## About

Lunchbox started as a Vue + ThreeJS custom renderer, but from version 2 on will be focused on web components built into browsers.

## Local Dev

`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.

`npm run test` to run headless tests, `npm run cy:open` to open Cypress test suites.

`npm run docs:dev` to run docs locally.

## Publishing

`npm run test` to make sure all tests pass, then `npm run publish`.
2 changes: 1 addition & 1 deletion packages/lunchboxjs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"types": "./dist/src/index.d.ts"
}
},
"version": "2.0.0",
"version": "2.0.1",
"type": "module",
"types": "./dist/src/index.d.ts",
"scripts": {
Expand Down

0 comments on commit f573ade

Please sign in to comment.