Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,44 +21,51 @@ We intend to support:
- and many more.

## Installation
### from a cloned repository

just run
You can install this library in two different ways.

### Install via NPM/Yarn

```shell
$ yarn add api-flow
# or
$ npm install api-flow
```

### Install from source

Just run:

```sh
git clone https://github.com/luckymarmot/API-Flow.git
cd API-Flow
make install
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also the target make install does not exist.

```

This will install the node module dependencies

## Building the different libraries
### node, web, and webworker

run the following command to build API-Flow for the different environments that you need
This will install the node module dependencies, but you will need to build API-Flow for the different environments that you need:

```sh
# use TARGET="node" if you only want the node library
make runners TARGET="node web webworker"
```

### Paw
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't really explain how this is Paw related, kinda seems like this is for building outputs in general. Remember, a lot of people will have no idea that this repo has anything to do with paw. It's just an A <> B converter.


You can use the following command to add the different extensions to Paw

```sh
# use TARGET="swagger" if you only want the swagger bindings
make transfer TARGET="swagger raml1 postman2"
```

## Using the npm module
### as a standard library
## Usage

### Standard Library

```js
const ApiFlow = require('api-flow'); // if from npm
const ApiFlow = require('api-flow'); // if from yarn/npm
const ApiFlow = require('./dist/node/api-flow.js'); // if from `make runners TARGET="node"`

const path = require('path');

const options = {
source: {
format: 'swagger',
Expand Down