Skip to content

Commit

Permalink
Update readme with screenshot and extra http headers (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthomas23 authored Sep 17, 2024
1 parent 087ba57 commit 47f5f9e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A terminal for JupyterLite.

⚠️ This extension is still in development and not yet ready for general use. ⚠️

![a screenshot showing a terminal running in JupyterLite](https://github.com/jupyterlite/terminal/assets/591645/1b4ff620-e8f2-4abf-b608-6badd66370ac)
![a screenshot showing a terminal running in JupyterLite](https://raw.githubusercontent.com/jupyterlite/terminal/main/screenshot.png)

## Requirements

Expand Down Expand Up @@ -85,9 +85,11 @@ jupyter lite build
And serve it:

```bash
jupyter lite serve
jupyter lite serve --LiteBuildConfig.extra_http_headers=Cross-Origin-Embedder-Policy=require-corp --LiteBuildConfig.extra_http_headers=Cross-Origin-Opener-Policy=same-origin
```

The extra HTTP headers are require to ensure that `SharedArrayBuffer` is available.

### Packaging the extension

See [RELEASE](RELEASE.md)

0 comments on commit 47f5f9e

Please sign in to comment.