Skip to content

Commit 96f590d

Browse files
committed
Added use cases and screenshots to readme
1 parent 83f7d3f commit 96f590d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Module for converting 2D Python lists to a fancy ASCII/Unicode tables
66
- [📥 Installation](#-installation)
77
- [🧑‍💻 Usage](#-usage)
88
- [⚙️ Options](#️-options)
9+
- [👨‍🎨 Use cases](#-use-cases)
910
- [🧰 Development](#-development)
1011

1112

@@ -62,6 +63,22 @@ print(output)
6263

6364
Soon table2ascii will support more options for customization.
6465

66+
## 👨‍🎨 Use cases
67+
68+
### Discord messages and embeds
69+
70+
* Display tables nicely inside markdown codeblocks on Discord
71+
* Useful for making Discord bots with [Discord.py](https://github.com/Rapptz/discord.py)
72+
73+
![image](https://user-images.githubusercontent.com/20955511/116203248-2973c600-a744-11eb-97d8-4b75ed2845c9.png)
74+
75+
### Terminal outputs
76+
77+
* Tables display nicely whenever monospace fonts are fully supported
78+
* Tables make terminal outputs look more professional
79+
80+
![image](https://user-images.githubusercontent.com/20955511/116204490-802dcf80-a745-11eb-9b4a-7cef49f23958.png)
81+
6582

6683
## 🧰 Development
6784

0 commit comments

Comments
 (0)