summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSergey Grebenshchikov <sgreben@gmail.com>2018-03-31 15:09:24 +0200
committerSergey Grebenshchikov <sgreben@gmail.com>2018-03-31 15:09:24 +0200
commit0aca02dc1e7ee25371e0d9f1d3d447973bd21b8b (patch)
tree27f73b0a7ee90f600bef890bcfcbe20ce1b9cc8b
parent54d45c14fdae120db63328ae5c43cd49115fad9e (diff)
Update README.md
-rw-r--r--README.md12
-rw-r--r--README.template.md12
2 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index 45c4f42..b816c76 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# jp
-Dead simple terminal plots from JSON (or CSV) data. Bar charts, line charts, and scatter plots are supported.
+Dead simple terminal plots from JSON (or CSV) data. Bar charts, line charts, scatter plots, histograms and heatmaps are supported.
[![Build Status](https://travis-ci.org/sgreben/jp.svg?branch=master)](https://travis-ci.org/sgreben/jp)
@@ -53,7 +53,7 @@ unzip jp_1.1.9_windows_x86_64.zip
## Use it
-`jp` reads JSON on stdin and prints plots to stdout.
+`jp` reads JSON (or CSV) on stdin and prints plots to stdout.
```text
Usage of jp:
@@ -65,16 +65,16 @@ Usage of jp:
y values (JSONPath expression)
-xy string
x,y value pairs (JSONPath expression). Overrides -x and -y if given.
+ -bins uint
+ Number of histogram bins (default 0 (auto))
+ -input value
+ Input type. One of [json csv] (default json)
-height int
Plot height (default 0 (auto))
-width int
Plot width (default 0 (auto))
-canvas value
Canvas type. One of [full quarter braille auto] (default auto)
- -bins uint
- Number of histogram bins (default 0 (auto))
- -input value
- Input type. One of [json csv] (default json)
```
## Examples
diff --git a/README.template.md b/README.template.md
index a69ae0a..5496c52 100644
--- a/README.template.md
+++ b/README.template.md
@@ -1,6 +1,6 @@
# jp
-Dead simple terminal plots from JSON (or CSV) data. Bar charts, line charts, and scatter plots are supported.
+Dead simple terminal plots from JSON (or CSV) data. Bar charts, line charts, scatter plots, histograms and heatmaps are supported.
[![Build Status](https://travis-ci.org/sgreben/jp.svg?branch=master)](https://travis-ci.org/sgreben/jp)
@@ -53,7 +53,7 @@ unzip jp_${VERSION}_windows_x86_64.zip
## Use it
-`jp` reads JSON on stdin and prints plots to stdout.
+`jp` reads JSON (or CSV) on stdin and prints plots to stdout.
```text
Usage of jp:
@@ -65,16 +65,16 @@ Usage of jp:
y values (JSONPath expression)
-xy string
x,y value pairs (JSONPath expression). Overrides -x and -y if given.
+ -bins uint
+ Number of histogram bins (default 0 (auto))
+ -input value
+ Input type. One of [json csv] (default json)
-height int
Plot height (default 0 (auto))
-width int
Plot width (default 0 (auto))
-canvas value
Canvas type. One of [full quarter braille auto] (default auto)
- -bins uint
- Number of histogram bins (default 0 (auto))
- -input value
- Input type. One of [json csv] (default json)
```
## Examples