chore(docs): updated readme
This commit is contained in:
@@ -1,6 +1,10 @@
|
||||
<div align="center">
|
||||
<a href="https://hoppscotch.io">
|
||||
<img height=64 src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/main/static/logo.png" alt="The Hoppscotch UFO logo" />
|
||||
<img
|
||||
src="https://avatars.githubusercontent.com/u/56705483"
|
||||
alt="Hoppscotch Logo"
|
||||
height="64"
|
||||
/>
|
||||
</a>
|
||||
</div>
|
||||
<div align="center">
|
||||
@@ -12,29 +16,36 @@
|
||||
This package deals with providing a JavaScript sandbox for executing various security sensitive external scripts.
|
||||
|
||||
## Usage
|
||||
- Install the [npm package](https://www.npmjs.com/package/@hoppscotch/js-sandbox)
|
||||
|
||||
Install the [npm package](https://www.npmjs.com/package/@hoppscotch/js-sandbox).
|
||||
|
||||
```
|
||||
npm install --save @hoppscotch/js-sandbox
|
||||
```
|
||||
|
||||
## How does this work ?
|
||||
## How does this work?
|
||||
|
||||
This package makes use of [quickjs-empscripten](https://www.npmjs.com/package/quickjs-emscripten) for building sandboxes for running external code on Hoppscotch.
|
||||
|
||||
Currently implemented sandboxes:
|
||||
- Hoppscotch Test Scripts
|
||||
|
||||
## Development
|
||||
- Clone the repository
|
||||
|
||||
1. Clone the repository
|
||||
|
||||
```
|
||||
git clone https://github.com/hoppscotch/hopp-js-sandbox
|
||||
```
|
||||
|
||||
- Install the package deps
|
||||
2. Install the package dependencies
|
||||
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
- Try out the demo [`src/demo.ts`](https://github.com/hoppscotch/hopp-js-sandbox/blob/main/src/demo.ts) using
|
||||
3. Try out the demo [`src/demo.ts`](https://github.com/hoppscotch/hopp-js-sandbox/blob/main/src/demo.ts) using:
|
||||
|
||||
```
|
||||
npm run demo
|
||||
```
|
||||
@@ -48,9 +59,7 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
|
||||
<div align="center">
|
||||
<br />
|
||||
<br />
|
||||
<br />
|
||||
|
||||
|
||||
###### built with ❤︎ by the [Hoppscotch Team](https://github.com/hoppscotch) and [contributors](https://github.com/AndrewBastin/hopp-js-sandbox/graphs/contributors).
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user