Skip to content

Commit 6a1dfca

Browse files
authored
Update README.md
1 parent 6e9dc17 commit 6a1dfca

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
<a href="https://www.npmjs.com/package/puppet-run" target="_blank"><img alt="npm (tag)" src="https://img.shields.io/npm/v/puppet-run.svg?style=flat-square"></a>
55
</p>
66

7-
Run any JavaScript or TypeScript code in a headless browser using puppeteer and pipe it's output back to your terminal 🔥
7+
Run any JavaScript / TypeScript code in a headless browser using [Puppeteer](https://github.com/GoogleChrome/puppeteer) and pipe its output to your terminal 🔥
88

99
Transparently bundles input files, so you can use `require()` and ES module imports. You can even simulate connectivity issues and serve static files. Great for testing client-side code in an actual browser!
1010

1111
How does it relate to [Karma](https://karma-runner.github.io)? It's everything that Karma is not: It's small, it's fast and trivial to set up.
1212

13-
🚀&nbsp;&nbsp;Runs any script in a headless Chrome<br />
13+
🚀&nbsp;&nbsp;Runs any script in a headless Chrome browser<br />
1414
📦&nbsp;&nbsp;Zero-config transparent bundling<br />
15-
⚙️&nbsp;&nbsp;Uses existing Babel, TypeScript, ... config if present<br />
1615
💡&nbsp;&nbsp;Supports TypeScript, ES modules &amp; JSX out of the box<br />
1716
🖥&nbsp;&nbsp;Pipes console output and errors to host shell<br />
17+
⚙️&nbsp;&nbsp;Uses custom Babel, TypeScript, ... config if present<br />
1818

1919

2020
## Installation
@@ -36,7 +36,7 @@ npx puppet-run [<arguments>]
3636
node ./node_modules/.bin/puppet-run [<arguments>]
3737
```
3838

39-
Pass any JavaScript or TypeScript file to `puppet-run` as an entrypoint. It will be transpiled by Babel using `@babel/preset-env`, `@babel/preset-react` & `@babel/preset-typescript` and bundled using `browserify`. It normally works out-of-the-box with zero configuration.
39+
Pass any JavaScript or TypeScript file to `puppet-run` as an entrypoint. It will be transpiled by Babel and bundled using `browserify`. It normally works out-of-the-box with zero configuration.
4040

4141
```sh
4242
npx puppet-run [...puppet-run options] ./path/to/script.js [...script options]
@@ -55,7 +55,7 @@ npx puppet-run --plugin=mocha [...mocha options] ./path/to/*.test.js
5555
npx puppet-run --help
5656
```
5757

58-
Print help text how to use this plugin:
58+
To print a plugin's help text:
5959

6060
```sh
6161
npx puppet-run --plugin=mocha --help
@@ -74,7 +74,7 @@ console.log(`I am being run in a browser: ${navigator.userAgent}`)
7474
puppet.exit()
7575
```
7676

77-
Don't forget to call `puppet.exit()` when the script is done, so `puppet-run` knows that the script is finished. You can also exit with a non-zero exit code using `puppet.exit(statusCode: number)`.
77+
Don't forget to call `puppet.exit()` when the script is done, so `puppet-run` knows that the script has finished. You can also exit with a non-zero exit code using `puppet.exit(statusCode: number)`.
7878

7979
Check out the "Scripting API" section below if you want to learn more about the globally available `puppet` object.
8080

0 commit comments

Comments
 (0)