summaryrefslogtreecommitdiff
path: root/node_modules/postcss-replace-overflow-wrap/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/postcss-replace-overflow-wrap/README.md')
-rw-r--r--node_modules/postcss-replace-overflow-wrap/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/node_modules/postcss-replace-overflow-wrap/README.md b/node_modules/postcss-replace-overflow-wrap/README.md
new file mode 100644
index 00000000..9c8f5f3d
--- /dev/null
+++ b/node_modules/postcss-replace-overflow-wrap/README.md
@@ -0,0 +1,56 @@
+# PostCSS Replace Overflow Wrap [![CSS Standard Status][css-img]][css] [![Build Status][ci-img]][ci]
+
+[PostCSS] plugin to replace overflow-wrap with word-wrap. May optionally retain both declarations.
+
+[PostCSS]: https://github.com/postcss/postcss
+[css-img]: https://jonathantneal.github.io/css-db/badge/css-text-overflow-wrap-property.svg
+[css]: https://jonathantneal.github.io/css-db/#css-text-overflow-wrap-property
+[ci-img]: https://travis-ci.org/MattDiMu/postcss-replace-overflow-wrap.svg
+[ci]: https://travis-ci.org/MattDiMu/postcss-replace-overflow-wrap
+
+
+```css
+/* before */
+.foo {
+ overflow-wrap: break-word;
+}
+
+/* after */
+.foo {
+ word-wrap: break-word;
+}
+```
+
+```css
+/* before, when the option { method: 'copy' } is passed */
+.foo {
+ overflow-wrap: break-word;
+}
+
+/* after */
+.foo {
+ word-wrap: break-word;
+ overflow-wrap: break-word;
+}
+```
+
+### Installation
+`npm install --save-dev postcss postcss-replace-overflow-wrap`
+
+For Postcss 7 or earlier use Version 3 or earlier:
+
+`npm install --save-dev postcss-replace-overflow-wrap@3`
+
+
+## Usage
+
+```js
+/* default usage, with no options (method = replace) */
+postcss([ require('postcss-replace-overflow-wrap') ])
+```
+
+```js
+/* add word-wrap, but keep overflow-wrap */
+postcss([ require('postcss-replace-overflow-wrap') ])({ method: 'copy' })
+```
+See [PostCSS] docs for examples for your environment.