diff --git a/README.md b/README.md index 5c4ab75..c846f86 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,21 @@ Unlike other modules, you can print single rows of data at a time (useful for pr Also, `tableprint` is fast (minimal processing required) and is therefore relevant for printing updates during speed-intensive computations. ## Installation +```bash +pip install tableprint +``` ## Usage +The `tableprint.table()` function takes in a matrix of data, a list of headers, and an optional dictionary of parameters. To print a dataset consisting of 10 rows of 3 different columns: +```python +import tableprint +import numpy as np + +data = np.random.randn(10,3) +headers = ['Column A', 'Column B', 'Column C'] + +tableprint.table(data, headers) +``` ## License MIT Licensed. See `License.md`