Update readme, bump version.

README.md

@@ -2401,6 +2401,34 @@ To stop a transition, call `fadePlugin.stopTransition()`. This will immediately
 
 The plugin automatically tracks `setDirty()` function calls in objects, materials and the scene. It can be triggerred by calling `setDirty` on any material or object in the scene. Check the [example](https://threepipe.org/examples/#frame-fade-plugin/) for a demo. This can be disabled by options in the plugin.
 
+## VignettePlugin
+
+[//]: # (todo: image)
+
+Example: https://threepipe.org/examples/#vignette-plugin/
+
+Source Code: [src/plugins/postprocessing/VignettePlugin.ts](./src/plugins/postprocessing/VignettePlugin.ts)
+
+API Reference: [VignettePlugin](https://threepipe.org/docs/classes/VignettePlugin.html)
+
+VignettePlugin adds a post-processing material extension to the ScreenPass in render manager
+that applies a vignette effect to the final render. The parameters `power` and `color` can be changed to customize the effect.
+
+```typescript
+import {ThreeViewer, VignettePlugin} from 'threepipe'
+
+const viewer = new ThreeViewer({...})
+
+const vignettePlugin = viewer.addPluginSync(VignettePlugin)
+
+// Change the vignette color
+vignettePlugin.power = 1
+vignettePlugin.color = new Color(0.5, 0, 0)
+
+// or 
+// vignettePlugin.color.set('#ff0000'); vignettePlugin.setDirty() // Call setDirty to tell the plugin that color has changed
+```
+
 ## HDRiGroundPlugin
 
 [//]: # (todo: image)

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "threepipe",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "threepipe",
-      "version": "0.0.16",
+      "version": "0.0.17",
       "license": "Apache-2.0",
       "dependencies": {
         "@types/three": "https://github.com/repalash/three-ts-types/releases/download/v0.152.1017/package.tgz",
@@ -39,7 +39,7 @@
         "rollup-plugin-license": "^3.0.1",
         "rollup-plugin-postcss": "^4.0.2",
         "stats.js": "^0.17.0",
-        "three": "https://github.com/repalash/three.js-modded/releases/download/v0.152.2015/package.tgz",
+        "three": "https://github.com/repalash/three.js-modded/releases/download/v0.152.2018/package.tgz",
         "tslib": "^2.5.0",
         "typedoc": "^0.24.7",
         "typescript": "^5.0.4",
@@ -9533,9 +9533,9 @@
       }
     },
     "node_modules/three": {
-      "version": "0.152.2015",
-      "resolved": "https://github.com/repalash/three.js-modded/releases/download/v0.152.2015/package.tgz",
-      "integrity": "sha512-qON7KCzBCV2cWH4uOg6rfSJw5otIRk3JK7i8VtRq9K0KWaD/c3aW2Uz/WRqOJDxW/ENNrKhb171nqlToJIkgcg==",
+      "version": "0.152.2018",
+      "resolved": "https://github.com/repalash/three.js-modded/releases/download/v0.152.2018/package.tgz",
+      "integrity": "sha512-88iZkx5sx/DQpfjB50omkR8b0tJ3UY+X9R1RpnpzVXZntDeUCsxTorscxAPX9MMmoE+Xfa9SFFxbVEOdm14YMQ==",
       "dev": true,
       "license": "MIT"
     },
@@ -17285,8 +17285,8 @@
       }
     },
     "three": {
-      "version": "https://github.com/repalash/three.js-modded/releases/download/v0.152.2015/package.tgz",
-      "integrity": "sha512-qON7KCzBCV2cWH4uOg6rfSJw5otIRk3JK7i8VtRq9K0KWaD/c3aW2Uz/WRqOJDxW/ENNrKhb171nqlToJIkgcg==",
+      "version": "https://github.com/repalash/three.js-modded/releases/download/v0.152.2018/package.tgz",
+      "integrity": "sha512-88iZkx5sx/DQpfjB50omkR8b0tJ3UY+X9R1RpnpzVXZntDeUCsxTorscxAPX9MMmoE+Xfa9SFFxbVEOdm14YMQ==",
       "dev": true
     },
     "through": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "threepipe",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "A 3D viewer framework built on top of three.js in TypeScript with a focus on quality rendering, modularity and extensibility.",
   "main": "src/index.ts",
   "module": "dist/index.mjs",

src/viewer/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.16'
+export const VERSION = '0.0.17'