@@ -28,11 +28,17 @@ import memeplotlib as memes
2828
2929# One-liner meme from a memegen template
3030memes.meme(" buzz" , " memes" , " memes everywhere" )
31+ ```
32+
33+ ![ buzz meme example] ( docs/_static/examples/readme_buzz_basic.png )
3134
35+ ``` python
3236# Save to file
3337memes.meme(" doge" , " such code" , " very bug" , savefig = " meme.png" , show = False )
3438```
3539
40+ ![ doge meme example] ( docs/_static/examples/readme_doge_savefig.png )
41+
3642## Features
3743
3844### Functional API
@@ -43,11 +49,19 @@ import memeplotlib as memes
4349# Customize text styling
4450memes.meme(" drake" , " writing tests" , " shipping to prod" ,
4551 font = " impact" , color = " yellow" )
52+ ```
53+
54+ ![ drake functional example] ( docs/_static/examples/readme_drake_functional.png )
4655
56+ ``` python
4757# Get figure/axes back for further customization
4858fig, ax = memes.meme(" distracted" , " my project" , " new framework" , " me" ,
4959 show = False )
60+ ```
5061
62+ ![ distracted functional example] ( docs/_static/examples/readme_distracted_functional.png )
63+
64+ ``` python
5165# Use a local image as template
5266memes.meme(" /path/to/image.jpg" , " top text" , " bottom text" )
5367```
@@ -62,11 +76,17 @@ m = Meme("buzz")
6276m.top(" memes" )
6377m.bottom(" memes everywhere" )
6478m.save(" output.png" )
79+ ```
80+
81+ ![ buzz OO example] ( docs/_static/examples/readme_buzz_oo.png )
6582
83+ ``` python
6684# Or chained
6785Meme(" doge" ).top(" such code" ).bottom(" very bug" ).show()
6886```
6987
88+ ![ doge OO example] ( docs/_static/examples/readme_doge_oo.png )
89+
7090### Memify Existing Plots
7191
7292Turn any matplotlib figure into a meme:
@@ -80,6 +100,8 @@ ax.plot([1, 2, 3], [1, 4, 9])
80100memes.memify(fig, " stonks" )
81101```
82102
103+ ![ memify stonks example] ( docs/_static/examples/readme_memify_stonks.png )
104+
83105### Global Configuration
84106
85107``` python
0 commit comments