kettanaito/INSTALL.md

## INSTALL.md

      
    Raw
  

              INSTALL.md
            
          
    Beta Program

Thank you for deciding to participate in the closed beta of our new library called "Source"! Through your feedback we will be able to refine it, making the lives of thousands of developers easier.
What is this library about?

The Source library allows you to generate request handlers from various sources. Currently, we support only HTTP archives (HAR) and OpenAPI (Swagger).
What do you expect from me?


Try out the library in your projects! We've written a bunch of tests but nothing compares to testing a solution on the actual battleground.
Expect things to break. This is a very early version of the library. It's okay if some things won't work as expected, if not at all.
After completing the program, please fill in the feedback form. This will help us gather your feedback and outline our future priotities when it comes to the library. Thank you!

Are there any deadlines?

There are no strict deadlines, although we would appreciate it if you could complete the program in 1 month period (by March 1st). Completing the program simply means that you've tried out the library and feel comfortable sharing your thoughts on it.
Getting started

Download

curl https://website-4fyknlmdh-mswjs.vercel.app/mswjs-source-v0.0.1.tgz --output mswjs-source-v0.0.1.tgz

Alternatively, download the tarball file manually.

Install

npm install ./mswjs-source-v0.0.1.tgz

# Or with Yarn:
yarn add ./mswjs-source-v0.0.1.tgz
Use

import { fromTraffic, fromOpenApi } from '@mswjs/source'
Please refer to the node_modules/@mswjs/source/README.md for documentation and usage examples.
Discretion notice

This library is not yet public. Please do not commit it or its tarball to Git, if you're planning on testing it on a public repository. You can still commit your own usage of the library, though. Installing it via a tarball will keep the package.json entry as usual, and you can ignore the tarball itself via .gitignore.