Skip to content

Commit 4ce1732

Browse files
committed
fix: update README to reflect package name change from @impulse/testing to @impulselab/testing
1 parent 1852379 commit 4ce1732

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Impulse Testing is a modern E2E testing library built on Puppeteer that allows y
2121
Run Impulse Testing for the first time to set up your project:
2222

2323
```bash
24-
npx impulse-testing --init
24+
npx @impulselab/testing --init
2525
```
2626

2727
The interactive onboarding will:
@@ -35,7 +35,7 @@ The interactive onboarding will:
3535
Create a new test by recording your interactions:
3636

3737
```bash
38-
npx impulse-testing --new
38+
npx @impulselab/testing --new
3939
```
4040

4141
Then:
@@ -53,15 +53,15 @@ Your interactions are saved as a reusable YAML story in `.testing/stories/{story
5353
#### Interactive Mode (Local Development)
5454

5555
```bash
56-
npx impulse-testing
56+
npx @impulselab/testing
5757
```
5858

5959
Select a story from the list and watch it execute. If screenshots differ, you'll see a visual diff and can choose to accept or reject changes.
6060

6161
#### CI Mode (Automated Testing)
6262

6363
```bash
64-
npx impulse-testing --ci
64+
npx @impulselab/testing --ci
6565
```
6666

6767
Runs all stories headlessly with automatic failure on screenshot mismatches. Perfect for CI/CD pipelines.
@@ -71,7 +71,7 @@ Runs all stories headlessly with automatic failure on screenshot mismatches. Per
7171
### Default Mode (Interactive)
7272

7373
```bash
74-
npx impulse-testing
74+
npx @impulselab/testing
7575
```
7676

7777
Opens an interactive shell where you can:
@@ -82,15 +82,15 @@ Opens an interactive shell where you can:
8282
### Recording Mode
8383

8484
```bash
85-
npx impulse-testing --new
85+
npx @impulselab/testing --new
8686
```
8787

8888
Directly starts the story creation flow, skipping the interactive menu.
8989

9090
### CI/CD Mode
9191

9292
```bash
93-
npx impulse-testing --ci
93+
npx @impulselab/testing --ci
9494
```
9595

9696
Runs all stories in non-interactive mode:
@@ -102,20 +102,20 @@ Runs all stories in non-interactive mode:
102102

103103
```bash
104104
# Run a single story
105-
npx impulse-testing --story user-login
105+
npx @impulselab/testing --story user-login
106106

107107
# Run multiple stories
108-
npx impulse-testing --story login --story checkout --story profile
108+
npx @impulselab/testing --story login --story checkout --story profile
109109

110110
# Run specific stories in CI mode
111-
npx impulse-testing --ci --story login --story checkout
111+
npx @impulselab/testing --ci --story login --story checkout
112112
```
113113

114114
### Help and Version
115115

116116
```bash
117-
npx impulse-testing --help
118-
npx impulse-testing --version
117+
npx @impulselab/testing --help
118+
npx @impulselab/testing --version
119119
```
120120

121121
## Configuration
@@ -228,7 +228,7 @@ Impulse Testing automatically generates stable CSS selectors using this priority
228228

229229
### Recording Workflow
230230

231-
1. **Start Recording**: Run `npx impulse-testing --new`
231+
1. **Start Recording**: Run `npx @impulselab/testing --new`
232232
2. **Provide Metadata**: Enter story name, ID, and start URL
233233
3. **Interact Naturally**: Click, type, and navigate as a real user would
234234
4. **Capture Snapshots**: Click "Take Snapshot" button at key moments to capture visual states
@@ -239,7 +239,7 @@ Impulse Testing automatically generates stable CSS selectors using this priority
239239

240240
#### Local Development
241241

242-
1. **Run Interactive Mode**: `npx impulse-testing`
242+
1. **Run Interactive Mode**: `npx @impulselab/testing`
243243
2. **Select Story**: Choose from the list of available stories
244244
3. **Watch Execution**: See each action execute in real-time
245245
4. **Review Results**: If screenshots differ:
@@ -249,7 +249,7 @@ Impulse Testing automatically generates stable CSS selectors using this priority
249249

250250
#### CI/CD Pipeline
251251

252-
1. **Add to Pipeline**: Add `npx impulse-testing --ci` to your CI config
252+
1. **Add to Pipeline**: Add `npx @impulselab/testing --ci` to your CI config
253253
2. **Automatic Execution**: All stories run headlessly without user interaction
254254
3. **Screenshot Validation**: Any pixel differences cause test failure
255255
4. **Exit Codes**:
@@ -272,7 +272,7 @@ jobs:
272272
with:
273273
node-version: '18'
274274
- run: npm install
275-
- run: npx impulse-testing --ci
275+
- run: npx @impulselab/testing --ci
276276
```
277277

278278
## Screenshot Comparison
@@ -338,8 +338,8 @@ When differences are detected:
338338
339339
```bash
340340
# Clone repository
341-
git clone https://github.com/your-org/impulse-testing.git
342-
cd impulse-testing
341+
git clone https://github.com/impulse-studio/testing.git
342+
cd testing
343343
344344
# Install dependencies
345345
pnpm install

0 commit comments

Comments
 (0)