diff --git a/README.md b/README.md index d03d2aa..2b088b6 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,66 @@ # Keploy VS Code Extension -Keploy is a Visual Studio Code extension designed to help developers record and replay test cases directly within the IDE. +Keploy is a Visual Studio Code extension that integrates the Keploy testing platform directly into your development workflow. -> Note: This extension currently supports only Go, Node, Python and Java programming language. +It enables developers to record real API interactions, generate test cases, replay them deterministically, and manage test configurations β€” all without leaving the IDE. -## Features +> **Supported Languages:** Go, Node.js, Python, and Java +--- -### Record and Replay TestCases. -### View Previous TestRun Result. -### View and Edit Keploy Config File +## πŸš€ Features +- Record and Replay Test Cases +- View Previous Test Run Results +- View and Edit Keploy Configuration Files +--- -## Installation +## 🧭 Who Is This Extension For? -1. Install the Keploy extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/). +This extension is ideal for: -2. Keploy CLI is present : - `curl --silent -O -L https://keploy.io/install.sh && source install.sh` +- Backend developers building APIs +- Microservice-based applications +- Teams practicing test-driven development +- Developers who want to auto-generate and replay API tests +--- +## πŸ”„ Typical Workflow -## Contirbution Guide +1. Install the Keploy CLI. +2. Run your backend service locally. +3. Use the extension to record API traffic. +4. Replay captured test cases inside the IDE. +5. View previous test run results. +6. Modify and manage Keploy configuration directly from VS Code. +--- -### Start in development mode - -1. Run `npm install` to install any dependencies. +## πŸ“¦ Installation -2. Press `F5` to open a new window with your extension loaded. +1. Install the Keploy extension from the VS Code Marketplace. -3. Set breakpoints in your code inside `src/extension.ts` to debug your extension. +2. Install the Keploy CLI: +```bash +curl --silent -O -L https://keploy.io/install.sh && source install.sh +``` +--- +## 🀝 Contribution Guide -4. From the debug console, you can see the output or errors if any. +### Start in development mode +1. Run `npm install` to install dependencies. +2. Press `F5` to open a new window with your extension loaded. +3. Set breakpoints in `src/extension.ts` to debug. +4. View logs in the debug console. ### Make changes to Frontend -1. Run `npm run rollup` to compile your svelte files into js files present in `out/compiled` dir. - -2. Make changes to your svelte code and the js files will be automatically re-compiled. - -3. Inorder to view your changes, after starting the extension in development mode, Press (`Ctrl+R` or `Cmd+R` on Mac) to reload the window with the fresh compiled js. - -4. To view the dev tools, press `ctrl + shift + p` to open the command palette and run `> Developer: Open Webview Developer tools` to open chrome dev tools. - - -### Make - -1. You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`. - -2. You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes. - -3. `package.json` - this is the manifest file in which you declare your extension and command. - * The sample plugin registers a command and defines its title and command name. With this information VS Code can show the command in the command palette. It doesn’t yet need to load the plugin. +1. Run `npm run rollup` to compile Svelte files. +2. Changes auto-compile to `out/compiled`. +3. Reload VS Code window using `Ctrl + R` (or `Cmd + R` on Mac). +4. Open Command Palette and run `Developer: Open Webview Developer Tools` for debugging. -4. `src/extension.ts` - this is the main file where you will provide the implementation of your command. - * The file exports one function, `activate`, which is called the very first time your extension is activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`. +### Make changes to Extension Logic - * We pass the function containing the implementation of the command as the second parameter to `registerCommand`. \ No newline at end of file +1. Relaunch extension from debug toolbar after editing `src/extension.ts`. +2. Reload VS Code window to apply updates. +3. `package.json` defines extension metadata and commands. +4. `src/extension.ts` contains command registration inside the `activate` function. now