Skip to content

Commit 6b2894a

Browse files
committed
Added screenshot to front-page README
1 parent 53c0b44 commit 6b2894a

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Many other modules for formatting tabular data require the developer to create a
1414
objects/data into a structure the formatter can consume. One relatively novel aspect of tableformatter is the ability to directly
1515
receive arbitrary Python objects.
1616

17+
[![Screenshot](tf.png)](https://github.com/python-tableformatter/tableformatter/blob/master/tf.png)
18+
1719
Main Features
1820
-------------
1921
- Easy to display simple tables with just one function call when you don't need the fine-grained control
@@ -34,7 +36,7 @@ pip install tableformatter
3436

3537
Dependencies
3638
------------
37-
``tableformatter`` depends on the [wcwidth](https://github.com/jquast/wcwidth) module for measuring the width of
39+
``tableformatter`` depends on the [wcwidth](https://github.com/jquast/wcwidth) module for measuring the width of
3840
unicode strings rendered to a terminal.
3941

4042
If you wish to use the optional support for color, then at least one of the following two modules must be installed:
@@ -47,7 +49,7 @@ If both ``colorama`` and ``colored`` are installed, then ``colored`` will take p
4749
Usage
4850
=====
4951
For simple cases, you only need to use a single function from this module: ``generate_table``. The only required argument
50-
to this function is ``rows`` which is an Iterable of Iterables such as a list of lists or another tabular data type like
52+
to this function is ``rows`` which is an Iterable of Iterables such as a list of lists or another tabular data type like
5153
a 2D [numpy](http://www.numpy.org) array. ``generate_table`` outputs a nicely formatted table:
5254

5355
```Python
@@ -132,7 +134,7 @@ print(generate_table(rows, cols, transpose=True))
132134
║ Col3 ║ A3 │ B3 │ C3 │ D3 ║
133135
║ Col4 ║ A4 │ B4 │ C4 │ D4 ║
134136
╚══════╩════╧════╧════╧════╝
135-
```
137+
```
136138

137139
Column Alignment
138140
----------------

tf.png

131 KB
Loading

0 commit comments

Comments
 (0)