super-three 0.136.1 → 0.144.0

package/README.md

@@ -1,55 +1,50 @@
-three.js
-========
+# three.js
 
 [![NPM Package][npm]][npm-url]
 [![Build Size][build-size]][build-size-url]
 [![NPM Downloads][npm-downloads]][npmtrends-url]
-[![Language Grade][lgtm]][lgtm-url]
+[![DeepScan][deepscan]][deepscan-url]
+[![Discord][discord]][discord-url]
 
-#### JavaScript 3D library ####
+#### JavaScript 3D library
 
 The aim of the project is to create an easy to use, lightweight, cross-browser, general purpose 3D library. The current builds only include a WebGL renderer but WebGPU (experimental), SVG and CSS3D renderers are also available in the examples.
 
 [Examples](https://threejs.org/examples/) —
-[Documentation](https://threejs.org/docs/) —
+[Docs](https://threejs.org/docs/) —
+[Manual](https://threejs.org/manual/) —
 [Wiki](https://github.com/mrdoob/three.js/wiki) —
 [Migrating](https://github.com/mrdoob/three.js/wiki/Migration-Guide) —
-[Questions](http://stackoverflow.com/questions/tagged/three.js) —
+[Questions](https://stackoverflow.com/questions/tagged/three.js) —
 [Forum](https://discourse.threejs.org/) —
-[Slack](https://join.slack.com/t/threejs/shared_invite/zt-rnuegz5e-FQpc6YboDVW~5idlp7GfDw) —
-[Discord](https://discordapp.com/invite/HF4UdyF)
+[Discord](https://discord.gg/56GBJwAnUS)
 
-### Usage ###
+### Usage
 
 This code creates a scene, a camera, and a geometric cube, and it adds the cube to the scene. It then creates a `WebGL` renderer for the scene and camera, and it adds that viewport to the `document.body` element. Finally, it animates the cube within the scene for the camera.
 
 ```javascript
-import * as THREE from './js/three.module.js';
+import * as THREE from 'three';
 
-let camera, scene, renderer;
-let geometry, material, mesh;
+// init
 
-init();
+const camera = new THREE.PerspectiveCamera( 70, window.innerWidth / window.innerHeight, 0.01, 10 );
+camera.position.z = 1;
 
-function init() {
+const scene = new THREE.Scene();
 
-	camera = new THREE.PerspectiveCamera( 70, window.innerWidth / window.innerHeight, 0.01, 10 );
-	camera.position.z = 1;
+const geometry = new THREE.BoxGeometry( 0.2, 0.2, 0.2 );
+const material = new THREE.MeshNormalMaterial();
 
-	scene = new THREE.Scene();
+const mesh = new THREE.Mesh( geometry, material );
+scene.add( mesh );
 
-	geometry = new THREE.BoxGeometry( 0.2, 0.2, 0.2 );
-	material = new THREE.MeshNormalMaterial();
+const renderer = new THREE.WebGLRenderer( { antialias: true } );
+renderer.setSize( window.innerWidth, window.innerHeight );
+renderer.setAnimationLoop( animation );
+document.body.appendChild( renderer.domElement );
 
-	mesh = new THREE.Mesh( geometry, material );
-	scene.add( mesh );
-
-	renderer = new THREE.WebGLRenderer( { antialias: true } );
-	renderer.setSize( window.innerWidth, window.innerHeight );
-	renderer.setAnimationLoop( animation );
-	document.body.appendChild( renderer.domElement );
-
-}
+// animation
 
 function animation( time ) {
 
@@ -61,9 +56,9 @@ function animation( time ) {
 }
 ```
 
-If everything went well, you should see [this](https://jsfiddle.net/vy29n6aj/).
+If everything went well, you should see [this](https://jsfiddle.net/7u84j6kp/).
 
-### Cloning this repository ###
+### Cloning this repository
 
 Cloning the repo with all its history results in a ~2 GB download. If you don't need the whole history you can use the `depth` parameter to significantly reduce download size.
 
@@ -71,7 +66,7 @@ Cloning the repo with all its history results in a ~2 GB download. If you don't
 git clone --depth=1 https://github.com/mrdoob/three.js.git
 ```
 
-### Change log ###
+### Change log
 
 [Releases](https://github.com/mrdoob/three.js/releases)
 
@@ -82,5 +77,8 @@ git clone --depth=1 https://github.com/mrdoob/three.js.git
 [build-size-url]: https://bundlephobia.com/result?p=three
 [npm-downloads]: https://img.shields.io/npm/dw/three
 [npmtrends-url]: https://www.npmtrends.com/three
-[lgtm]: https://img.shields.io/lgtm/alerts/github/mrdoob/three.js
-[lgtm-url]: https://lgtm.com/projects/g/mrdoob/three.js/
+[deepscan]: https://deepscan.io/api/teams/16600/projects/19901/branches/525701/badge/grade.svg
+[deepscan-url]: https://deepscan.io/dashboard#view=project&tid=16600&pid=19901&bid=525701
+[discord]: https://img.shields.io/discord/685241246557667386
+[discord-url]: https://discord.gg/56GBJwAnUS
+