Skip to content

Commit 48991cd

Browse files
committed
Update README
1 parent fc52d06 commit 48991cd

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
# rollup-plugin-glsl-optimize
22
[![NPM Package][npm]][npm-url]
3-
[![Node.js CI][ci]][ci-url]
4-
[![NPM Publish][npm-publish]][npm-publish-url]
5-
[![Tool Binaries][tool-binaries]][tool-binaries-url]
3+
[![Changelog][changelog]][changelog-url]
4+
![Node Version][node-version]
5+
![Types][types]
66

77
[![Maintainability][cc-maintainability]][cc-maintainability-url]
88
[![Coverage Status][coverage]][coverage-url]
99
[![Dependencies][dependencies]][dependencies-url]
1010
[![Dev Dependencies][dev-dependencies]][dev-dependencies-url]
1111

12+
[![Node.js CI][ci]][ci-url]
13+
[![NPM Publish][npm-publish]][npm-publish-url]
14+
[![Tool Binaries][tool-binaries]][tool-binaries-url]
15+
1216
Import GLSL source files as strings. Pre-processed, validated and optimized with [Khronos Group SPIRV-Tools](https://github.com/KhronosGroup/SPIRV-Tools).
1317

1418
Primary use-case is processing WebGL2 / GLSL ES 300 shaders.
1519

16-
*Plugin supports node >= 14.x*
17-
1820
```js
1921
import frag from './shaders/myShader.frag';
2022
console.log(frag);
@@ -121,6 +123,9 @@ The following shader stages are supported by the Khronos tools and recognized by
121123
- ``extraValidatorParams``, ``extraOptimizerParams``, ``extraCrossParams`` : ``string[]`` (default undefined) Additional parameters for the Khronos Glslang Validator [here](doc/glslangValidator.md), the Khronos SPIR-V Optimizer [here](doc/spirv-opt.md), and the Khronos SPIR-V Cross compiler [here](doc/spirv-cross.md).
122124
- ``glslangValidatorPath``, ``glslangOptimizerPath``, ``glslangCrossPath`` : ``string`` (default undefined) Provide / override binary tool paths. Note the environment variables always take precedence if set.
123125

126+
## Changelog
127+
Available in [CHANGES.md][changelog].
128+
124129
## License
125130

126131
Released under the [MIT license](LICENSE).
@@ -139,6 +144,10 @@ Released under the [MIT license](LICENSE).
139144
[npm-publish-url]: https://github.com/docd27/rollup-plugin-glsl-optimize/actions/workflows/npm-publish.yml
140145
[npm]: https://img.shields.io/npm/v/rollup-plugin-glsl-optimize.svg
141146
[npm-url]: https://www.npmjs.com/package/rollup-plugin-glsl-optimize
147+
[node-version]: https://img.shields.io/node/v/rollup-plugin-glsl-optimize
148+
[types]: https://img.shields.io/npm/types/rollup-plugin-glsl-optimize
149+
[changelog]: https://img.shields.io/static/v1?label=SemVer&message=Changelog&style=flat&color=blue&logo=github
150+
[changelog-url]: https://github.com/docd27/rollup-plugin-glsl-optimize/blob/master/CHANGES.md
142151
[dependencies]: https://img.shields.io/david/docd27/rollup-plugin-glsl-optimize.svg
143152
[dependencies-url]: https://david-dm.org/docd27/rollup-plugin-glsl-optimize
144153
[dev-dependencies]: https://img.shields.io/david/dev/docd27/rollup-plugin-glsl-optimize.svg

0 commit comments

Comments
 (0)