diff options
Diffstat (limited to 'vendor/supports-hyperlinks/README.md')
| -rw-r--r-- | vendor/supports-hyperlinks/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/supports-hyperlinks/README.md b/vendor/supports-hyperlinks/README.md new file mode 100644 index 0000000..f01ef92 --- /dev/null +++ b/vendor/supports-hyperlinks/README.md @@ -0,0 +1,28 @@ +Detects whether the current terminal supports [hyperlinks in terminal +emulators](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda). + +It tries to detect and support all known terminals and terminal families that +support this. If a declaration is wrong, missing, or could be improved, please +send a PR! + +## Example + +The API is super simple! + +```rust +use supports_hyperlinks::Stream; + +if supports_hyperlinks::on(Stream::Stdout) { + println!("This terminal supports hyperlinks on stdout"); +} else { + println!("No hyperlinks, please"); +} +``` + +And that's it! + +## Forcing hyperlinks in tools that use `supports-hyperlinks` + +You may set the `FORCE_HYPERLINK` environment variable to force +`supports-hyperlinks` to return true for its checks. If the value is `0`, this +will force it to be _false_, instead. |