From 0c389701fe14bd406ea1dfbe248a98a059a6a3ad Mon Sep 17 00:00:00 2001 From: liyasthomas Date: Sat, 25 Sep 2021 12:21:19 +0530 Subject: [PATCH] chore(docs): updated readme --- README.md | 14 +++++++----- packages/hoppscotch-js-sandbox/README.md | 29 ++++++++++++++++-------- 2 files changed, 27 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a1c80a999..00923e748 100644 --- a/README.md +++ b/README.md @@ -302,9 +302,10 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._ ### Local development environment 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. -2. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). -3. Start the development server with `pnpm run dev`. -4. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. +2. Install pnpm using npm by running `npm install -g pnpm`. +3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). +4. Start the development server with `pnpm run dev`. +5. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. ### Docker compose @@ -323,9 +324,10 @@ docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest ## **Releasing** 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. -2. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). -3. Build the release files with `pnpm run generate`. -4. Find the built project in `packages/hoppscotch-app/dist`. +2. Install pnpm using npm by running `npm install -g pnpm`. +3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). +4. Build the release files with `pnpm run generate`. +5. Find the built project in `packages/hoppscotch-app/dist`. ## **Contributing** diff --git a/packages/hoppscotch-js-sandbox/README.md b/packages/hoppscotch-js-sandbox/README.md index e1193cb4d..77b12a755 100644 --- a/packages/hoppscotch-js-sandbox/README.md +++ b/packages/hoppscotch-js-sandbox/README.md @@ -1,6 +1,10 @@
- The Hoppscotch UFO logo + Hoppscotch Logo
@@ -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


-
- ###### built with ❤︎ by the [Hoppscotch Team](https://github.com/hoppscotch) and [contributors](https://github.com/AndrewBastin/hopp-js-sandbox/graphs/contributors). - -
\ No newline at end of file + +