Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kettanaito committed May 8, 2024
1 parent 11a9ad6 commit ada314b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

<h1 align="center">Source</h1>

This library allows you to generate request handlers for [Mock Service Worker](https://github.com/mswjs/msw) from different sources, like an HAR file, an OpenAPI specification, or Node.js process runtime.
Generate [MSW](https://github.com/mswjs/msw) request handlers from OpenAPI documents, HAR archives, and other sources.

Once generated, you can supply the request handlers to whichever MSW setup you need to enable API mocking as usual.
Here's an exampe of the [Node.js integration](https://mswjs.io/docs/integrations/node) of MSW using request handlers generated from a `github.com.har` file:

```js
import { setupServer } from 'msw/node'
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@mswjs/source",
"version": "0.0.0",
"description": "Generate MSW request handlers from OpenAPI specs, HAR archives, and other sources.",
"description": "Generate MSW request handlers from OpenAPI documents, HAR archives, and other sources.",
"main": "./lib/index.js",
"module": "./lib/index.mjs",
"types": "./lib/index.d.ts",
Expand Down

0 comments on commit ada314b

Please sign in to comment.