Skip to content

Commit 043ac06

Browse files
committed
Update readme with docs
1 parent e98839b commit 043ac06

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
[![version](https://img.shields.io/pypi/v/table2ascii)](https://pypi.org/project/table2ascii/)
55
[![downloads](https://static.pepy.tech/personalized-badge/table2ascii?period=total&units=none&left_color=grey&right_color=orange&left_text=downloads)](https://pepy.tech/project/table2ascii)
66
[![license](https://img.shields.io/pypi/l/table2ascii)](https://github.com/DenverCoder1/table2ascii/blob/main/LICENSE)
7-
[![Discord](https://img.shields.io/discord/819650821314052106?color=5865F2&logo=discord&logoColor=white "Dev Pro Tips Discussion & Support Server")](https://discord.gg/fPrdqh3Zfu)
7+
[![discord](https://img.shields.io/discord/819650821314052106?color=5865F2&logo=discord&logoColor=white "Dev Pro Tips Discussion & Support Server")](https://discord.gg/fPrdqh3Zfu)
88

99
Library for converting 2D Python lists to fancy ASCII/Unicode tables
1010

11+
Documentation and examples are available at [table2ascii.rtfd.io](https://table2ascii.readthedocs.io/)
12+
1113
## 📥 Installation
1214

13-
``pip install table2ascii``
15+
``pip install -U table2ascii``
1416

1517
**Requirements:** `Python 3.7+`
1618

@@ -141,7 +143,7 @@ print(output)
141143

142144
## 🎨 Preset styles
143145

144-
See a list of all preset styles [here](https://github.com/DenverCoder1/table2ascii/tree/main/style_list).
146+
See a list of all preset styles [here](https://table2ascii.readthedocs.io/en/latest/styles.html).
145147

146148
## ⚙️ Options
147149

@@ -178,11 +180,11 @@ All parameters are optional.
178180

179181
### Running tests
180182

181-
Install `tox`:
183+
**Install requirements**
182184

183-
``pip install tox``
185+
``pip install -U tox``
184186

185-
Run tests:
187+
**Run tests**
186188

187189
``tox``
188190

0 commit comments

Comments
 (0)