summaryrefslogtreecommitdiff
path: root/vendor/is_ci/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/is_ci/README.md')
-rw-r--r--vendor/is_ci/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/vendor/is_ci/README.md b/vendor/is_ci/README.md
new file mode 100644
index 0000000..d923a75
--- /dev/null
+++ b/vendor/is_ci/README.md
@@ -0,0 +1,27 @@
+This crate tells you if you're in a CI environment or not. It does not tell
+you **which** you're in, but it makes a good effort to make sure to accurately
+tell you whether you're in one.
+
+This crate is based on the
+[`@npmcli/ci-detect`](https://npm.im/@npmcli/ci-detect) package.
+
+If you need more information about the specific CI environment you're running
+in and you can handle a heavier dependency, please consider using
+[`ci_info`](https://crates.io/crates/ci_info) instead.
+
+## Example
+
+```rust
+// You can call this repeatedly if you want to get the same result, cached.
+let am_i_in_ci_right_now = is_ci::cached();
+
+// If you expect your environment to change between calls, use this instead:
+let checking_again_just_in_case = is_ci::uncached();
+```
+
+## License
+
+`is_ci` is released to the Rust community under the [ISC License](./LICENSE).
+
+It is based on `@npmcli/ci-detect` which is released to the community under
+the [ISC License](https://github.com/npm/ci-detect/blob/main/LICENSE).