aboutsummaryrefslogtreecommitdiff
path: root/node_modules/urix/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/urix/readme.md')
-rw-r--r--node_modules/urix/readme.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/node_modules/urix/readme.md b/node_modules/urix/readme.md
new file mode 100644
index 0000000..b258b98
--- /dev/null
+++ b/node_modules/urix/readme.md
@@ -0,0 +1,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).