aboutsummaryrefslogtreecommitdiff
path: root/node_modules/has-yarn/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/has-yarn/readme.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/has-yarn/readme.md')
-rw-r--r--node_modules/has-yarn/readme.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/node_modules/has-yarn/readme.md b/node_modules/has-yarn/readme.md
new file mode 100644
index 000000000..5ca107d90
--- /dev/null
+++ b/node_modules/has-yarn/readme.md
@@ -0,0 +1,53 @@
+# has-yarn [![Build Status](https://travis-ci.org/sindresorhus/has-yarn.svg?branch=master)](https://travis-ci.org/sindresorhus/has-yarn)
+
+> Check if a project is using [Yarn](https://yarnpkg.com)
+
+Useful for tools that needs to know whether to use `yarn` or `npm` to install dependencies.
+
+
+## Install
+
+```
+$ npm install --save has-yarn
+```
+
+
+## Usage
+
+```
+.
+├── foo
+│   └── package.json
+└── bar
+ ├── package.json
+ └── yarn.lock
+```
+
+```js
+const hasYarn = require('has-yarn');
+
+hasYarn('foo');
+//=> false
+
+hasYarn('bar');
+//=> true
+```
+
+
+## API
+
+### hasYarn([cwd])
+
+Returns a `boolean`.
+
+#### cwd
+
+Type: `string`<br>
+Default: `process.cwd()`
+
+Current working directory.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)