aboutsummaryrefslogtreecommitdiff
path: root/node_modules/decamelize/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/decamelize/readme.md')
-rw-r--r--node_modules/decamelize/readme.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/node_modules/decamelize/readme.md b/node_modules/decamelize/readme.md
new file mode 100644
index 000000000..624c7ee5e
--- /dev/null
+++ b/node_modules/decamelize/readme.md
@@ -0,0 +1,48 @@
+# decamelize [![Build Status](https://travis-ci.org/sindresorhus/decamelize.svg?branch=master)](https://travis-ci.org/sindresorhus/decamelize)
+
+> Convert a camelized string into a lowercased one with a custom separator<br>
+> Example: `unicornRainbow` → `unicorn_rainbow`
+
+
+## Install
+
+```
+$ npm install --save decamelize
+```
+
+
+## Usage
+
+```js
+const decamelize = require('decamelize');
+
+decamelize('unicornRainbow');
+//=> 'unicorn_rainbow'
+
+decamelize('unicornRainbow', '-');
+//=> 'unicorn-rainbow'
+```
+
+
+## API
+
+### decamelize(input, [separator])
+
+#### input
+
+Type: `string`
+
+#### separator
+
+Type: `string`<br>
+Default: `_`
+
+
+## Related
+
+See [`camelcase`](https://github.com/sindresorhus/camelcase) for the inverse.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)