summaryrefslogtreecommitdiff
path: root/node_modules/indent-string/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/indent-string/readme.md')
-rw-r--r--node_modules/indent-string/readme.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/indent-string/readme.md b/node_modules/indent-string/readme.md
new file mode 100644
index 0000000..89f14ac
--- /dev/null
+++ b/node_modules/indent-string/readme.md
@@ -0,0 +1,58 @@
+# indent-string [![Build Status](https://travis-ci.org/sindresorhus/indent-string.svg?branch=master)](https://travis-ci.org/sindresorhus/indent-string)
+
+> Indent each line in a string
+
+
+## Install
+
+```
+$ npm install --save indent-string
+```
+
+
+## Usage
+
+```js
+var indentString = require('indent-string');
+
+indentString('Unicorns\nRainbows', '♥', 4);
+//=> ♥♥♥♥Unicorns
+//=> ♥♥♥♥Rainbows
+```
+
+
+## API
+
+### indentString(string, indent, count)
+
+#### string
+
+**Required**
+Type: `string`
+
+The string you want to indent.
+
+#### indent
+
+**Required**
+Type: `string`
+
+The string to use for the indent.
+
+#### count
+
+Type: `number`
+Default: `1`
+
+How many times you want `indent` repeated.
+
+
+## Related
+
+- [indent-string-cli](https://github.com/sindresorhus/indent-string-cli) - CLI for this module
+- [strip-indent](https://github.com/sindresorhus/strip-indent) - Strip leading whitespace from every line in a string
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)