Skip to content

Commit dea8aba

Browse files
author
Ives van Hoorne
committed
Update README
1 parent 0c215bc commit dea8aba

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

packages/sandpack/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ This is a list of features that the bundler supports out of the box, the list ma
2424
6. Webpack loader syntax (`!raw-loader!./test.js`)
2525
7. Friendly error overlay (using `create-react-app` overlay)
2626
8. Transpilation result caching
27+
9. HTML/CSS entry points
2728

2829
## Example usage
2930

30-
This repo serves as an interface to communicate with the bundler. The bundler itself is hosted on `sandpack-{version}.codesandbox.io` and is heavily cached by a CDN. We also included the necessary files under `bundler` if you want to host the bundler yourself.
31+
This repo serves as an interface to communicate with the bundler. The bundler itself is hosted on `sandpack-{version}.codesandbox.io` and is heavily cached by a CDN. We also included the necessary files under `sandpack` if you want to host the bundler yourself.
3132

3233
### Using the Manager
3334

@@ -36,7 +37,8 @@ The Manager is a class implementation, you can use it by importing Manager.
3637
```js
3738
import { Manager } from 'sandpack';
3839

39-
// There are two ways of initializing a preview, you can give it either an iframe element or a selector of an element to create an iframe on.
40+
// There are two ways of initializing a preview, you can give it either an
41+
// iframe element or a selector of an element to create an iframe on.
4042
const manager = new Manager(
4143
'#preview',
4244
{
@@ -189,7 +191,8 @@ The third argument in the constructor of `Manager` is extra options. It has this
189191
*/
190192
height?: string;
191193
/**
192-
* If we should skip the third step: evaluation.
194+
* If we should skip the third step: evaluation. Useful if you only want to see
195+
* transpiled results
193196
*/
194197
skipEval?: boolean;
195198
}

0 commit comments

Comments
 (0)