Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-israel-turner committed Sep 5, 2021
1 parent 86d18eb commit b965ed2
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ Use fonts supporting ligatures such as [Fira Code][Fira Code],
**Disclaimer**: Please note that this plugin requires hyper version 2.1.0
or later.

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

### Using the built-in hyper plugin manager
```bash
Expand All @@ -30,15 +28,14 @@ plugins array to include `hyper-font-ligatures`:
```js
plugins: ['hyper-font-ligatures'],
```
### WebGL Rendering Issues

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

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

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

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

0 comments on commit b965ed2

Please sign in to comment.