Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pete-murphy committed Sep 7, 2022
1 parent 1f4b17a commit e805b7b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- PureScript syntax highlighting
- Run and print output or show resulting JavaScript
- Multiple view modes: code, output or both
- Persistent session
- Share code via URL
- Load PureScript code from GitHub Gists or repository files

### Control Features via the Query String
Expand All @@ -28,6 +28,11 @@ Most of these features can be controlled not only from the toolbar, but also usi
- Example: `gist=37c3c97f47a43f20c548`
- Notes: the file should be named `Main.purs` with the module name `Main`.

- **Load From URL**: Load code from editor state which is compressed and stored in the `purs` parameter
- Managed by Try PureScript and updated on editor state change to create shareable URLs
- Example: `purs=LYewJgrgNgpgBAWQIYEsB2cDuALGAnGIA` will set the editor state to the single line `module Main where`
- When used with the `gist` or `github` query parameters the latter will be ignored and the code will be loaded from the `purs` parameter

- **View Mode**: Control the view mode using the `view` parameter
- Options are: `code`, `output`, `both` (default)
- Example: `view=output` will only display the output
Expand All @@ -40,11 +45,6 @@ Most of these features can be controlled not only from the toolbar, but also usi
- Options are: `true`, `false` (default)
- Example: `js=true` will print JavaScript code instead of the program's output

- **Session**: Load code from a session which is stored with [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) using the `session` parameter
- Usually managed by Try PureScript
- Example: `session=9162f098-070f-4053-60ea-eba47021450d` (Note: will probably not work for you)
- When used with the `gist` or `github` query parameters the code will be loaded from the source file and not the session

### Which Libraries Are Available?

Try PureScript aims to provide a complete, recent package set from <https://github.com/purescript/package-sets>. The available libraries are those listed in [`staging/spago.dhall`](./staging/spago.dhall), at the versions in the package set mentioned in [`staging/packages.dhall`](./staging/packages.dhall).
Expand Down

0 comments on commit e805b7b

Please sign in to comment.