54 lines
1.4 KiB
Markdown
54 lines
1.4 KiB
Markdown
# is-relative [](http://badge.fury.io/js/is-relative)
|
|
|
|
> Returns `true` if the path appears to be relative.
|
|
|
|
## Install
|
|
|
|
Install with [npm](https://www.npmjs.com/)
|
|
|
|
```sh
|
|
$ npm i is-relative --save
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var isRelative = require('is-relative');
|
|
isRelative('README.md');
|
|
//=> true
|
|
```
|
|
|
|
## Other projects
|
|
|
|
* [is-absolute](https://github.com/jonschlinkert/is-absolute): Return true if a file path is absolute.
|
|
* [is-dotfile](https://github.com/jonschlinkert/is-dotfile): Return true if a file path is (or has) a dotfile.
|
|
* [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
|
|
* [is-unc-path](https://github.com/jonschlinkert/is-unc-path): Returns true if a filepath is a windows UNC file path.
|
|
|
|
## Running tests
|
|
|
|
Install dev dependencies:
|
|
|
|
```sh
|
|
$ npm i -d && npm test
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-relative/issues/new)
|
|
|
|
## Author
|
|
|
|
**Jon Schlinkert**
|
|
|
|
+ [github/jonschlinkert](https://github.com/jonschlinkert)
|
|
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
|
|
|
|
## License
|
|
|
|
Copyright © 2014-2015 [Jon Schlinkert](https://github.com/jonschlinkert)
|
|
Released under the MIT license.
|
|
|
|
***
|
|
|
|
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 11, 2015._ |