Skip to content

Commit 9072fed

Browse files
committed
1.1.0
1 parent e46a125 commit 9072fed

4 files changed

Lines changed: 19 additions & 16 deletions

File tree

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "mdtable-cli"
3-
version = "1.0.2"
3+
version = "1.1.0"
44
license = "MIT"
55
authors = ["Axel Lindeberg"]
66
description = "A tool that makes creating tables in markdown much easier!"

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,23 @@ Command line tool for generating markdown tables. It takes in CSV-formatted data
33

44
![Demo gif](./demo.gif)
55

6-
See also [Crates.io](https://crates.io/crates/mdtable-cli) link.
6+
See also the [Crates.io](https://crates.io/crates/mdtable-cli) page.
77

88
# Usage
9+
The application expects each row of the table as rows in the input, i.e rows separated by newlines. Each element of the row is seperated by a `,` (or another value see flag `-s`). This can either come from a file with a positional argument or from stdin. If from stdin you can signal the end of the table by either `EOF` or by an empty line (i.e hitting enter twice).
10+
11+
Here are some example cli usages:
12+
913
```
10-
mdtable -f table.csv -o mdtable.md
11-
mdtable -f table.csv > mdtable.md
14+
mdtable
15+
mdtable table.csv -o mdtable.md
16+
mdtable table.csv > mdtable.md
1217
cat table.csv | mdtable > mdtable.md
1318
```
14-
See `Options` for additional flags.
15-
16-
The application expects each row of the table as rows in the input, i.e rows separated by newlines. Each element of the row is seperated by a `,` (or another value, see flag `-s`).
1719

18-
This can either come from a file with the `-f` flag or from stdin. If from stdin you signal end of table by either `EOF` or by an empty line (i.e hitting enter twice).
20+
See `Options` for a full description program arguments.
1921

20-
See examples of input and output [here](./examples.md).
22+
For examples of input and corresponding output see [examples.md](./examples.md)
2123

2224
# Installation
2325
If you're a rust programmer (e.g you have `rustc` and `cargo`) simply do:
@@ -36,19 +38,20 @@ cargo build --release
3638
cp target/release/mdtable /usr/local/bin/
3739
```
3840

39-
4041
# Options
4142
```
4243
USAGE:
43-
mdtable [FLAGS] [OPTIONS]
44+
mdtable [FLAGS] [OPTIONS] [FILE]
4445
4546
FLAGS:
4647
-h, --help Prints help information
4748
-m, --minimize Minimizes table output
4849
-V, --version Prints version information
4950
5051
OPTIONS:
51-
-f, --file <file> Reads table values from this if given, stdin otherwise.
52-
-o, --out <outfile> Prints output to this if given, stdout otherwise.
53-
-s, --separator <separator> String that separates values. [default: ,]
52+
-o, --out <FILE> Prints output to this. [default: stdout]
53+
-s, --separator <STRING> Separates values. [default: ,]
54+
55+
ARGS:
56+
<FILE> Reads table tables from this. [default: stdin]
5457
```

src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pub struct Config {
1010
impl Config {
1111
pub fn from_args() -> Config {
1212
let args = App::new("mdtable")
13-
.version("1.0.2")
13+
.version("1.1.0")
1414
.author("Axel Lindeberg")
1515
.about("Makes creating tables in markdown much easier!")
1616
.arg(Arg::from_usage("[FILE] 'Reads table tables from this. [default: stdin]'"))

0 commit comments

Comments
 (0)