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