www.aleph1.co.uk Git - yaffs-website/blob - node_modules/is-relative/README.md

   1 # is-relative [![NPM version](https://badge.fury.io/js/is-relative.svg)](http://badge.fury.io/js/is-relative)
   2
   3 > Returns `true` if the path appears to be relative.
   4
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/)
   8
   9 ```sh
  10 $ npm i is-relative --save
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var isRelative = require('is-relative');
  17 isRelative('README.md');
  18 //=> true
  19 ```
  20
  21 ## Other projects
  22
  23 * [is-absolute](https://github.com/jonschlinkert/is-absolute): Return true if a file path is absolute.
  24 * [is-dotfile](https://github.com/jonschlinkert/is-dotfile): Return true if a file path is (or has) a dotfile.
  25 * [is-glob](https://github.com/jonschlinkert/is-glob): Returns `true` if the given string looks like a glob pattern.
  26 * [is-unc-path](https://github.com/jonschlinkert/is-unc-path): Returns true if a filepath is a windows UNC file path.
  27
  28 ## Running tests
  29
  30 Install dev dependencies:
  31
  32 ```sh
  33 $ npm i -d && npm test
  34 ```
  35
  36 ## Contributing
  37
  38 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-relative/issues/new)
  39
  40 ## Author
  41
  42 **Jon Schlinkert**
  43
  44 + [github/jonschlinkert](https://github.com/jonschlinkert)
  45 + [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  46
  47 ## License
  48
  49 Copyright © 2014-2015 [Jon Schlinkert](https://github.com/jonschlinkert)
  50 Released under the MIT license.
  51
  52 ***
  53
  54 _This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 11, 2015._