aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-ci/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
committerMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
commit383285ecd5292bf9a825e05904955b937de84cc9 (patch)
tree0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/is-ci/README.md
downloadequestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip
Initial commit
Diffstat (limited to 'node_modules/is-ci/README.md')
-rw-r--r--node_modules/is-ci/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/node_modules/is-ci/README.md b/node_modules/is-ci/README.md
new file mode 100644
index 0000000..bc3840a
--- /dev/null
+++ b/node_modules/is-ci/README.md
@@ -0,0 +1,50 @@
+# is-ci
+
+Returns `true` if the current environment is a Continuous Integration
+server.
+
+Please [open an issue](https://github.com/watson/is-ci/issues) if your
+CI server isn't properly detected :)
+
+[![npm](https://img.shields.io/npm/v/is-ci.svg)](https://www.npmjs.com/package/is-ci)
+[![Build status](https://travis-ci.org/watson/is-ci.svg?branch=master)](https://travis-ci.org/watson/is-ci)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+
+## Installation
+
+```bash
+npm install is-ci --save
+```
+
+## Programmatic Usage
+
+```js
+const isCI = require('is-ci')
+
+if (isCI) {
+ console.log('The code is running on a CI server')
+}
+```
+
+## CLI Usage
+
+For CLI usage you need to have the `is-ci` executable in your `PATH`.
+There's a few ways to do that:
+
+- Either install the module globally using `npm install is-ci -g`
+- Or add the module as a dependency to your app in which case it can be
+ used inside your package.json scripts as is
+- Or provide the full path to the executable, e.g.
+ `./node_modules/.bin/is-ci`
+
+```bash
+is-ci && echo "This is a CI server"
+```
+
+## Supported CI tools
+
+Refer to [ci-info](https://github.com/watson/ci-info#supported-ci-tools) docs for all supported CI's
+
+## License
+
+[MIT](LICENSE)