summaryrefslogtreecommitdiff
path: root/node_modules/shebang-regex/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/shebang-regex/readme.md')
-rw-r--r--node_modules/shebang-regex/readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/node_modules/shebang-regex/readme.md b/node_modules/shebang-regex/readme.md
new file mode 100644
index 0000000..5ecf863
--- /dev/null
+++ b/node_modules/shebang-regex/readme.md
@@ -0,0 +1,33 @@
+# shebang-regex [![Build Status](https://travis-ci.org/sindresorhus/shebang-regex.svg?branch=master)](https://travis-ci.org/sindresorhus/shebang-regex)
+
+> Regular expression for matching a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) line
+
+
+## Install
+
+```
+$ npm install shebang-regex
+```
+
+
+## Usage
+
+```js
+const shebangRegex = require('shebang-regex');
+
+const string = '#!/usr/bin/env node\nconsole.log("unicorns");';
+
+shebangRegex.test(string);
+//=> true
+
+shebangRegex.exec(string)[0];
+//=> '#!/usr/bin/env node'
+
+shebangRegex.exec(string)[1];
+//=> '/usr/bin/env node'
+```
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)