diff options
author | Jonas Bushart <jonas@bushart.org> | 2019-08-26 00:35:01 +0200 |
---|---|---|
committer | Jonas Bushart <jonas@bushart.org> | 2019-08-26 00:36:28 +0200 |
commit | 19805573d9260c074f19442b02d62cb8a1769913 (patch) | |
tree | 2196d98f4c791f2ab9efdfe921805a683330164a /README.md | |
parent | 66b913fa54ca0ce700506125867c3ab117f7667f (diff) |
Add description about the Evcxr support to the readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -29,6 +29,7 @@ A formatted and aligned table printer library for [Rust](https://www.rust-lang.o * [Importing](#user-content-importing)
* [Exporting](#user-content-exporting)
* [Note on line endings](#user-content-note-on-line-endings)
+ * [Evcxr Integration](#evcxr-integration)
## Including
@@ -379,3 +380,19 @@ on any platform. This customization capability will probably move to Formatting API in a future release.
Additional examples are provided in the documentation and in [examples](./examples/) directory.
+
+## Evcxr Integration
+
+[Evcxr][evcxr] is a Rust REPL and a [Jupyter notebook kernel][evcxr-jupyter].
+This crate integrates into Evcxr and the Jupyter notebooks using the `evcxr` feature flag, which enables native displays of tables.
+This includes support for displaying colors and various formattings.
+
+You can include prettytable as a dependency using this line:
+```
+:dep prettytable = { git = "https://github.com/phsym/prettytable-rs", package = "prettytable-rs", features = ["evcxr"] }
+```
+
+![prettytable being used in a Jupyter notebook with Evcxr Rust kernel.](./prettytable-evcxr.png)
+
+[evcxr]: https://github.com/google/evcxr/
+[evcxr-jupyter]: https://github.com/google/evcxr/blob/master/evcxr_jupyter/README.md
|