Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
255kb committed Nov 14, 2024
1 parent 916eaf0 commit e904015
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ Finally, you can onboard new team members faster by providing them with a consis

## GitHub Action Usage

Mockoon CLI, being a JavaScript application, can run on any environment where Node.js is installed, including continuous integration systems like GitHub Actions.

This GitHub Action allows you to run Mockoon CLI in your workflows.

Several parameters are available to customize the behavior of the action:

- The `version` of the CLI, default to `latest`.
- The `data-file`, pointing to a [Mockoon data file](https://mockoon.com/docs/latest/mockoon-data-files/data-storage-location/) stored in the repository.
- A `port` on which the mock server will run, default to `3000`.

```yaml
name: Mockoon CLI demo

Expand Down Expand Up @@ -63,6 +73,10 @@ This action is compatible with the following Mockoon CLI versions:
| <6.0.0 | v1 |
| >=6.0.0 | v2 |
## CLI's documentation
Mockoon CLI is available as an [NPM package](https://www.npmjs.com/package/@mockoon/cli). Please check our [dedicated documentation](https://github.com/mockoon/mockoon/blob/main/packages/cli/README.md) to learn how to install and use it.
## Subscribe to Mockoon Cloud
With advanced features for solo developers and teams, Mockoon Cloud supercharges your API development:
Expand Down

0 comments on commit e904015

Please sign in to comment.