summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPierre-Henri Symoneaux <pierre-henri.symoneaux@nokia.com>2016-09-11 21:01:14 +0200
committerPierre-Henri Symoneaux <pierre-henri.symoneaux@nokia.com>2016-09-11 21:07:21 +0200
commit65212fe72e77462d151fa880690228d370d87485 (patch)
tree035770775962b671f7c156fbb9fa2f97c948e9a7 /README.md
parentbee55a14260d1678ec6f786031084f71e34c9533 (diff)
Windows specific newlines is now a default feature
The feature is named `win_crlf` Fixes #33
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4dc949c..42723f8 100644
--- a/README.md
+++ b/README.md
@@ -273,4 +273,13 @@ Value three | Value four
Check API documentation for the full list of available predefined formats.
+## Note on line endings
+By default, the library prints tables with platform specific line ending. Thin means on Windows,
+newlines will be rendered with `\r\n` while on other platforms they will be rendered with `\n`.
+Since `v0.6.3`, platform specific line endings are activated though the default feature `win_crlf`, which can be deactivated.
+When this feature is deactivated (for instance with the `--no-default-features` flag in cargo), line endings will be rendered with `\n`
+on any platform.
+
+This customization capability will probably move to Formatting API in `v0.7`.
+
Additional examples are provided in the documentation and in [examples](./examples/) directory.