summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Roztocil <jakub@roztocil.co>2022-01-23 17:17:58 +0100
committerJakub Roztocil <jakub@roztocil.co>2022-01-23 17:17:58 +0100
commit217cf8ddae3615a2a0d96f7842c5feb22e5d9d0f (patch)
tree24d46ca7a2595d78050c68188c9e918add99b670
parent859e4420838b470e694460a9ba8a68962da2e833 (diff)
Document auto-stream
-rw-r--r--docs/README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index de82137c..9694e628 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1954,6 +1954,8 @@ You can use the `--stream, -S` flag to make two things happen:
1. The output is flushed in much smaller chunks without any buffering, which makes HTTPie behave kind of like `tail -f` for URLs.
2. Streaming becomes enabled even when the output is prettified: It will be applied to each line of the response and flushed immediately. This makes it possible to have a nice output for long-lived requests, such as one to the [Twitter streaming API](https://developer.twitter.com/en/docs/tutorials/consuming-streaming-data).
+The `--stream` option is automatically enabled when the response headers include `Content-Type: text/event-stream`.
+
### Example use cases
Prettified streamed response: