docs: update description in main README

davesheldon · Oct 9, 2023 · 5a8e781 · 5a8e781
1 parent 4133632
commit 5a8e781
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Nap is a command-line interface (CLI) for running HTTP requests using YAML files
+Nap is a command-line tool that utilizes YAML files to test APIs.
 
 ## Documentation
 

diff --git a/docs/reference/commands/run.md b/docs/reference/commands/run.md
@@ -57,7 +57,7 @@ Usage: `-p var1=val1 [-p var2=val2] ...`
 
 Initialize a variable. To include multiple parameters, use the flag multiple times. If the same variable name is supplied multiple times, only the last value will be used. The `--param` flag will also overwrite values loaded via the `--env` flag.
 
-### `--quiet` - Parameter
+### `--quiet` - Quiet Mode
 
 Alias: `-q`. `bool`. Optional
 

diff --git a/docs/reference/concepts/predicates.md b/docs/reference/concepts/predicates.md
@@ -28,7 +28,7 @@ A predicate will always appear _between_ a query and a value (such as an assert'
 | `contains` | Query contains value as a `string`. | `body contains Hello, World!` |
 | `startswith` | Query begins with value as a `string`. | `body startswith Hello` |
 | `endswith` | Query ends with value as a `string`. | `body endswith World!` |
-| `matches` | Query matches value as a regular expression | `body matches ^Hello.+$`  |
+| `matches` | Query matches value as a regular expression | `body matches ^Hello.+$` |
 | `in` | Query matches one of a set of values | `status in [ 200, 201 ]` |
 
 ## Negation

diff --git a/docs/reference/concepts/queries.md b/docs/reference/concepts/queries.md
@@ -17,13 +17,13 @@ A query describes a part of an HTTP response.
 
 Each query begins with a keyword. Here is a table of all supported keywords and their functions.
 
-| Keyword | Description |
-|:--------|:------------|
-| `body` | The raw HTTP response body, expressed as a string |
-| `duration` | The HTTP execution duration in milliseconds |
-| `header` | The value of an HTTP response header |
-| `jsonpath` | The result of a jsonpath expression |
-| `status` | The numeric HTTP response status code |
+| Keyword  | Description  |
+|:------------|:--------------------------------------------------|
+| `body`  | The raw HTTP response body, expressed as a string |
+| `duration`  | The HTTP execution duration in milliseconds  |
+| `header`  | The value of an HTTP response header  |
+| `jsonpath`  | The result of a jsonpath expression  |
+| `status`  | The numeric HTTP response status code  |
 
 ## Filters
 

diff --git a/docs/reference/file-types/requests.md b/docs/reference/file-types/requests.md
@@ -132,7 +132,7 @@ If present, defines the request as a GraphQL request, which sets the `verb` to `
 
 Sets the query in the GraphQL payload. Accepts either an inline query or a file-path via the `@` prefix.
 
-### `graphql.variables` - GraphQL Query
+### `graphql.variables` - GraphQL Variables
 
 `object`. Optional.
 

diff --git a/docs/the-basics.md b/docs/the-basics.md
@@ -111,6 +111,6 @@ Run finished in 326ms. 4/4 succeeded.
 This is the power of Nap. Since `subroutine-1.yml` and `subroutine-2.yml` aren't blocking each other, we can write a very large set of tests and have many of them running in parallel, making the whole test run much, much faster than solutions such as Postman or a regular bash script using `curl`.
 
 {: .warning }
-Be sure not to reference a routine from itself. Unless you like stalling forever, of course.
+Be sure not to reference a routine from itself, even indirectly. This will create an infinite loop, and your workload will stall!
 
 You can view the full code for example on Github [here](https://github.com/davesheldon/nap/tree/main/examples/routines/basic).