first commit

node_modules/eol/README.md

@@ -0,0 +1,60 @@
+# eol
+[Newline](http://en.wikipedia.org/wiki/Newline) character converter for JavaScript. Available [on npm](https://www.npmjs.com/package/eol).
+
+```
+npm install eol --save
+```
+
+### `require` or `import`
+
+```js
+const eol = require('eol')
+```
+
+```js
+import eol from 'eol'
+```
+
+## API
+
+### `eol.auto(text)`
+- Normalize line endings in <var>text</var> for the current operating system
+- <b>@return</b> string with line endings normalized to `\r\n` or `\n`
+
+### `eol.crlf(text)`
+- Normalize line endings in <var>text</var> to <b>CRLF</b> (Windows, DOS)
+- <b>@return</b> string with line endings normalized to `\r\n`
+
+### `eol.lf(text)`
+- Normalize line endings in <var>text</var> to <b>LF</b> (Unix, OS X)
+- <b>@return</b> string with line endings normalized to `\n`
+
+### `eol.cr(text)`
+- Normalize line endings in <var>text</var> to <b>CR</b> (Mac OS)
+- <b>@return</b> string with line endings normalized to `\r`
+
+### `eol.before(text)`
+- Add linebreak before <var>text</var>
+- <b>@return</b> string with linebreak added before text
+
+### `eol.after(text)`
+- Add linebreak after <var>text</var>
+- <b>@return</b> string with linebreak added after text
+
+### `eol.split(text)`
+- Split <var>text</var> by newline
+- <b>@return</b> array of lines
+
+### Joining
+
+Coercing `eol.auto`|`eol.crlf`|`eol.lf`|`eol.cr` to string yields the appropriate character. This is useful for joining.
+
+```js
+String(eol.lf) // "\n"
+eol.split(text).join(eol.auto) // same as eol.auto(text)
+eol.split(text).filter(line => line).join(eol.auto) // text joined after removing empty lines
+eol.split(text).slice(-3).join(eol.auto) // last 3 lines joined
+```
+
+## License
+MIT