Skip to content

Commit 9312b78

Browse files
committed
Update README
Update wording of description, add coming soon section
1 parent 7caad7c commit 9312b78

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,14 @@ This library provides a simple to use webgl shader component, with included fram
1111

1212
## Core Concepts
1313
### Why
14-
While libraries like [three.js](https://threejs.org/) are amazing, not every project requires the level of depth provided. This is a zero-dependency library that provides a simple to use component for rendering GLSL shaders on the web.
14+
While libraries like [three.js](https://threejs.org/) are amazing, not every project requires all the provided features. That's where simple-shader-component comes in; this is a zero-dependency library that provides a simple to use component for rendering GLSL shaders on the web.
1515

1616
## Installation & Usage
1717
```zsh
1818
bun i simple-shader-component
1919
```
2020

2121
The base class and types are all exported from the root of the package.
22-
```ts
23-
import { Shader } from 'simple-shader-component'
24-
```
25-
2622
Framework wrappers are available under sub exports.
2723
```ts
2824
import { SimpleShaderCanvas } from 'simple-shader-component/react'
@@ -87,4 +83,7 @@ export const Test = () => {
8783
}
8884
```
8985

90-
*More coming soon*
86+
*Coming Soon*
87+
- improved documentation
88+
- screenshots & examples of how shaders as a component can be used to add visual interest
89+
- roadmap

0 commit comments

Comments
 (0)