diff --git a/README.md b/README.md index f78174e2..e9afd559 100644 --- a/README.md +++ b/README.md @@ -72,14 +72,15 @@ app.listen(3000); Parrot is divided into several packages that can be used together depending on your use case. -| Name | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| **[parrot-core](https://github.com/americanexpress/parrot/blob/master/packages/parrot-core)** | Core Parrot functionality that can be extended to new use cases | -| **[parrot-devtools](https://github.com/americanexpress/parrot/blob/master/packages/parrot-devtools)** | Devtools that allow you to switch between Parrot scenarios | -| **[parrot-fetch](https://github.com/americanexpress/parrot/blob/master/packages/parrot-fetch)** | Fetch mocking implementation of Parrot | -| **[parrot-friendly](https://github.com/americanexpress/parrot/blob/master/packages/parrot-friendly)** | Helper library to write your scenarios in BDD style | -| **[parrot-graphql](https://github.com/americanexpress/parrot/blob/master/packages/parrot-graphql)** | Helper library to add GraphQL mocks to your scenarios | -| **[parrot-middleware](https://github.com/americanexpress/parrot/blob/master/packages/parrot-middleware)** | Express middleware implementation of Parrot | +| Name | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| **[parrot-core](https://github.com/americanexpress/parrot/blob/master/packages/parrot-core)** | Core Parrot functionality that can be extended to new use cases | +| **[parrot-devtools](https://github.com/americanexpress/parrot/blob/master/packages/parrot-devtools)** | Devtools that allow you to switch between Parrot scenarios | +| **[parrot-fetch](https://github.com/americanexpress/parrot/blob/master/packages/parrot-fetch)** | Fetch mocking implementation of Parrot | +| **[parrot-friendly](https://github.com/americanexpress/parrot/blob/master/packages/parrot-friendly)** | Helper library to write your scenarios in BDD style | +| **[parrot-graphql](https://github.com/americanexpress/parrot/blob/master/packages/parrot-graphql)** | Helper library to add GraphQL mocks to your scenarios | +| **[parrot-middleware](https://github.com/americanexpress/parrot/blob/master/packages/parrot-middleware)** | Express middleware implementation of Parrot | +| **[parrot-server](https://github.com/americanexpress/parrot/blob/master/packages/parrot-server)** | CLI to get a parrot server up and running | ## Contributing We welcome Your interest in the American Express Open Source Community on Github. diff --git a/packages/parrot-server/README.md b/packages/parrot-server/README.md new file mode 100644 index 00000000..f78266ed --- /dev/null +++ b/packages/parrot-server/README.md @@ -0,0 +1,11 @@ +# parrot-server + +parrot-server is a CLI that creates and starts up an express app that uses [parrot-middleware](https://github.com/americanexpress/parrot/blob/master/packages/parrot-middleware) + +## Example + +```bash +parrot-server --port 3001 --scenarios /path/to/scenarios.js +# could also use shorthand: +parrot-server -p 3001 -s /path/to/scenarios.js +``` \ No newline at end of file