add some documentation on the parameter 'silent' in the readme

FarazzShaikh · Jun 1, 2023 · e6cce06 · e6cce06
1 parent 61623af
commit e6cce06
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/package/README.md b/package/README.md
@@ -45,6 +45,7 @@ function Box() {
  baseMaterial: THREE.MeshPhysicalMaterial,
  vertexShader: /* glsl */ ` ... `,
  fragmentShader: /* glsl */ ` ... `,
+ silent: true, // Disables the default warning if true
  uniforms: {
  uTime: {
  value: 0,
@@ -83,6 +84,8 @@ function Cube() {
  baseMaterial={THREE.MeshPhysicalMaterial}
  vertexShader={/* glsl */ ` ... `}
  fragmentShader={/* glsl */ ` ... `}
+ {/*silent parameter to true disables the default warning if needed*/}
+ silent
  uniforms={{
  uTime: {
  value: 0,