From fca83bf79a9a96fab871fea54df1d090eec7d88b Mon Sep 17 00:00:00 2001 From: Alexander Jackson Date: Tue, 2 Jun 2020 21:36:02 +0100 Subject: [PATCH] Clarify stdin syntax highlighting in the README Clarify the requirements for automatic syntax highlighting when reading input from stdin. Fixes #1028. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb1e59f9..cb7692f1 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,9 @@ Display multiple files at once > bat src/*.rs ``` -Read from stdin, determine the syntax automatically +Read from stdin, determine the syntax automatically (note, this will only work +if the syntax can be determined from the initial line of the file, usually +through a shebang such as `#!/bin/sh`) ```bash > curl -s https://sh.rustup.rs | bat