Skip to content

Commit

Permalink
doc(README): v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Integralist committed Mar 27, 2024
1 parent 482e93d commit 3e2d854
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The `crs` command is a Rust version of the [Carbon](https://github.com/Integralist/carbon) CLI.

Carbon can make a HTTP request, then sort, filter and display the HTTP response headers.
Carbon can make a HTTP request, then sort, filter and display the HTTP response headers.

> **NOTE**: The name comes from carbon filtering: method of filtering impurities.
Expand All @@ -25,4 +25,13 @@ The default behaviour is to display all response headers, followed by the HTTP s

> **NOTE**: The following example pipes to [`jq`](https://stedolan.github.io/jq/) for pretty-printing.
![Example of filtering and JSON](./static/3-Filter-and-JSON.png)
![Example of filtering](./static/3-Filter.png)

![Example of filtering and JSON](./static/4-Filter-and-JSON.png)

### Response Body

- The `--body` flag will display the response body below the HTTP headers/status.

> **NOTE:** The `--body` flag is incompatible with the `--json` flag\
> i.e. don't use `--json` and also try to include the response body.
Binary file modified static/1-Help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/2-Default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/3-Filter-and-JSON.png
Binary file not shown.
Binary file added static/3-Filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/4-Filter-and-JSON.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/5-Body.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3e2d854

Please sign in to comment.