Skip to content

Commit 3064143

Browse files
authored
docs(readme): update installation instructions (#3)
Signed-off-by: slayerjain <[email protected]> Signed-off-by: slayerjain <[email protected]>
1 parent 60040a5 commit 3064143

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

+27-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
1-
# browser-extension
2-
Selenium extension to automatically record and mock the backend calls using Keploy for testing.
3-
This extension is of manifest version-3.
1+
# Selenium Browser Extensiom
2+
The Selenium browser extension is a plugin that enables Selenium IDE developers to record and replay Infrastructure (API, DB calls). It records these calls automatically while test-cases are being captured.
43

54
## Contents
6-
1. [Installation](#installation)
7-
2. [Usage](#usage)
8-
3. [Supported Clients](#supported-clients)
5+
1. [Prerequisite](#prerequisite)
6+
2. [Installation](#installation)
7+
3. [Usage](#usage)
8+
4. [Supported Clients](#supported-clients)
9+
10+
## Prerequisite
11+
1. Latest Google Chrome installed with a Google account and sync enabled.
12+
3. [Selenium IDE](https://www.selenium.dev/selenium-ide/) browser extenstion installed in the browser.
13+
4. Avoid having other extensions installed. Extensions such as `hoppscotch` can interfere with the keploy extension.
914

1015
## Installation
11-
Just need to install the web extension and make sure that sync is enabled on your google
12-
account. It will automatically configure with Selenium-IDE for testing.
16+
### Load in Dev mode
17+
1. Download the latest extension zip from here - `https://github.com/keploy/browser-extension/releases`
18+
2. Unzip/Extract the file. You can use the UI or use the commandline, eg: `unzip ~/Downloads/keploy-browser-extension-v0.1.3.zip`
19+
3. Go to the extensions manager and enable Dev mode as shown in the image below.
20+
4. Click on the `Load unpacked` button and select the folder and your extension should be loaded.
21+
<img width="757" alt="Screenshot 2022-08-23 at 11 29 19 AM" src="https://user-images.githubusercontent.com/12831254/186081488-c60e6a61-8527-47cc-9039-ac2266290b7a.png">
22+
23+
### Load from Chrome Web Store
24+
Coming Soon!
25+
26+
1327

1428
## Usage
1529
### Record
@@ -29,7 +43,8 @@ Overrides the send method and records the outputs of http calls during recording
2943
to return the mocked response.
3044

3145
## Limitations
32-
1. Since the outputs of dependency calls are stored in session storage, the recorded tests should not redirect to different origin.
33-
2. Maybe other web-extensions can interfare. Please remove them during testing.
34-
3. Sync should be enabled on google account because projectName is stored in chrome.storage.sync API.
35-
4. Currently, it cannot be installed in firefox because firefox browser do not supports manifest version v3.
46+
1. Fetch is not supported yet.
47+
2. Since the outputs of dependency calls are stored in session storage, the recorded tests should not redirect to different origin.
48+
3. Maybe other web-extensions can interfare. Please remove them during testing.
49+
4. Sync should be enabled on google account because projectName is stored in chrome.storage.sync API.
50+
5. Currently, it cannot be installed in firefox because firefox browser do not supports manifest version v3.

0 commit comments

Comments
 (0)