Blame view

node_modules/urix/readme.md 766 Bytes
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
  [![Build Status](https://travis-ci.org/lydell/urix.png?branch=master)](https://travis-ci.org/lydell/urix)
  
  Overview
  ========
  
  Makes Windows-style paths more unix and URI friendly. Useful if you work with
  paths that eventually will be used in URLs.
  
  ```js
  var urix = require("urix")
  
  // On Windows:
  urix("c:\\users\\you\\foo")
  // /users/you/foo
  
  // On unix-like systems:
  urix("c:\\users\\you\\foo")
  // c:\users\you\foo
  ```
  
  
  Installation
  ============
  
  `npm install urix`
  
  ```js
  var urix = require("urix")
  ```
  
  
  Usage
  =====
  
  ### `urix(path)` ###
  
  On Windows, replaces all backslashes with slashes and uses a slash instead of a
  drive letter and a colon for absolute paths.
  
  On unix-like systems it is a no-op.
  
  
  License
  =======
  
  [The X11 (“MIT”) License](LICENSE).