From 458f0f65ce8d0de0622033c3efa6420c80e066cc Mon Sep 17 00:00:00 2001 From: David Diaz Date: Sat, 23 Dec 2017 00:46:23 -0600 Subject: [PATCH] Updated ReadMe --- .gitignore | 1 + README.md | 26 +++++++++++++++----------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index c2658d7..25fbf5a 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ node_modules/ +coverage/ diff --git a/README.md b/README.md index 5047c11..526f562 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,27 @@ ## What is Beau? Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo. -![A Gif showing how beau works](http://files.martianwabbit.com/beau.gif) +![A Gif showing how beau works](http://files.martianwabbit.com/beau2.gif) ## Installation npm install -g beau ## Usage - beau [options] -r + ⚡ beau --help - Options: + Usage: beau [options] [command] - -h, --help output usage information - -V, --version output the version number - -r, --request [request] The alias for the request you'd like to trigger. - -v, --verbose Show all the information related to the current request and it's response. - -c, --config [file] Specify your request config file. Defaults to beau.yml in the current directory. - -l, --list List all requests in the config file. - -t, --truncate [length] Truncate the content to the given length + + Options: + + -V, --version output the version number + -h, --help output usage information + + + Commands: + + request [options] + list [options] ## Example Configuration File @@ -50,7 +54,7 @@ Beau, is a CLI that executes HTTP requests based on a YAML configuration file. T archived: true ## Example Usage - beau -r profile + beau request profile That would execute the profile request along with it´s dependencies. In this case, the session request would be made as well since we are using it´s response value as part of our current request.