summary refs log tree commit diff
path: root/resources/app/node_modules/electron-is-dev/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'resources/app/node_modules/electron-is-dev/readme.md')
-rw-r--r--resources/app/node_modules/electron-is-dev/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/resources/app/node_modules/electron-is-dev/readme.md b/resources/app/node_modules/electron-is-dev/readme.md
new file mode 100644
index 0000000..b950c45
--- /dev/null
+++ b/resources/app/node_modules/electron-is-dev/readme.md
@@ -0,0 +1,42 @@
+# electron-is-dev
+
+> Check if [Electron](https://electronjs.org) is running in development
+
+Useful for enabling debug features only during development.
+
+You can use this module directly in both the main and renderer process.
+
+
+## Install
+
+```
+$ npm install electron-is-dev
+```
+
+*Requires Electron 3 or later.*
+
+
+## Usage
+
+```js
+const isDev = require('electron-is-dev');
+
+if (isDev) {
+	console.log('Running in development');
+} else {
+	console.log('Running in production');
+}
+```
+
+You can force development mode by setting the `ELECTRON_IS_DEV` environment variable to `1`.
+
+
+## Related
+
+- [electron-util](https://github.com/sindresorhus/electron-util) - Useful utilities for developing Electron apps
+- [electron-debug](https://github.com/sindresorhus/electron-debug) - Adds useful debug features to your Electron app
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)