Skip to content

Commit 7d66ef3

Browse files
Update README
1 parent 86d18eb commit 7d66ef3

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ Use fonts supporting ligatures such as [Fira Code][Fira Code],
1515
**Disclaimer**: Please note that this plugin requires hyper version 2.1.0
1616
or later.
1717

18-
**Also note**: For those on hyper 3+, you must
19-
[disable WebGL rendering](#disabling-webgl-rendering) for this
20-
plugin to function.
18+
**Also note**: For those using WebGL, there are several known issues. To avoid these issues, [disable WebGL rendering](#disabling-webgl-rendering).
2119

2220
### Using the built-in hyper plugin manager
2321
```bash
@@ -30,15 +28,14 @@ plugins array to include `hyper-font-ligatures`:
3028
```js
3129
plugins: ['hyper-font-ligatures'],
3230
```
31+
### WebGL Rendering Issues
3332

34-
### Disabling WebGL Rendering
33+
If you are running hyper with WebGL rendering enabled, you may run into some rendering glitches. See these issues for more information:
3534

36-
if you are running hyper 3+, this plugin currently does not work with hyper 3
37-
unless you disable WebGL rendering.
35+
- https://github.com/vercel/hyper/issues/5757
36+
- https://github.com/xtermjs/xterm.js/issues/3303
3837

39-
Note that WebGL rendering was a major performance improvement introduced
40-
in hyper 3, by disabling it you should expect the same level of performance
41-
seen with hyper 2.
38+
### Disabling WebGL Rendering
4239

4340
To disable WebGL rendering, set `webGLRenderer` to `false` in the `config`
4441
section of your

0 commit comments

Comments
 (0)