Add description about the Evcxr support to the readme

3 files changed, 21 insertions, 1 deletions

diff --git a/Cargo.toml b/Cargo.toml
index b6be3b1..b860676 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -12,6 +12,9 @@ keywords = ["tab", "table", "format", "pretty", "print"]
 categories = ["command-line-interface"]

 license = "BSD-3-Clause"

 edition = "2018"

+exclude = [

+    "prettytable-evcxr.png"

+]

 

 [badges]

 appveyor = { repository = "phsym/prettytable-rs", branch = "master", service = "github" }

@@ -20,7 +23,7 @@ codecov = { repository = "phsym/prettytable-rs", branch = "master", service = "g
 

 [features]

 default = ["win_crlf", "csv"]

-evcxr = []
+evcxr = []

 win_crlf = []

 

 [[bin]]

diff --git a/README.md b/README.md
index d702cf8..d1fa0ea 100644
--- a/README.md
+++ b/README.md
@@ -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

diff --git a/prettytable-evcxr.png b/prettytable-evcxr.png
new file mode 100644
index 0000000..22264be
--- /dev/null
+++ b/prettytable-evcxr.png