diff --git a/docs/README.md b/docs/README.md index 6b74353..cdf0e44 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,46 +1,26 @@ -#Hello +#Commands + +You can generate memes by using the following arguments: + +``` +[meme id] "text1" "text2" ... +``` + +Depending of the number of `"text"` arguments, several behavior occurs: +* **None**: you get the template that gives you locations of texts. (see below) +* **Less than the template's**: the remaining texts are blank on the output +* **More than the template's**: the extra arguments are ignored + +> Notes +> * You don't have to use all texts shown on templates +> * You can use an empty text argument ( `""` ) to skip a text and keep it blank + +#List of templates + +You can find here the full list of templates. +Each one has extra info and an image showing how texts are placed. +Click on an image to enlarge it. + -|||| -|:---:|:---:|:---:| -|**aliens**|**alive**
alt: no_brain|**argument**
alt: wrestlers| -|||| -|**bender**
alt: hookers, blackjack|**born_cool**|**brain3**| -|||| -|**brain4**
alt: brains|**brain5**|**buff**
alt: tom, jerry| -|||| -|**burn**|**button**|**bye_mom**
alt: google| -|||| -|**clock**|**culture**
alt: anime|**disappointed**| -|||| -|**distracted**
alt: boyfried, cheating, girlfriend|**dont_look**
alt: ricky, mom, influenced|**drake**| -|||| -|**drift**|**everywhere**
alt: buzz, woody|**everywhere2**
alt: angry| -|||| -|**fight**
alt: vaping|**fine**
alt: fire|**flex_tape**| -|||| -|**gate**|**girl_cat**|**grandma**| -|||| -|**gru**|**guys**|**handshake**| -|||| -|**handshake2**|**idea**|**lion**
alt: shady, king| -|||| -|**meeting**
alt: boardroom, suggestion|**mini**
alt: joker|**nobody_cares**
alt: nobody, jurassic, park, jurassic_park| -|||| -|**nope**|**overconfident**
alt: alcohol, depressed|**patrick**
alt: wallet, id| -|||| -|**pigeon**
alt: butterfly|**pills**|**pleasure3**
alt: satisfied3| -|||| -|**pleasure4**
alt: pleasure, satisfied, satisfied4|**salt_bae**
alt: salt|**scary**
alt: spongebob, fearless| -|||| -|**seagull2**
alt: seagull, screaming|**seagull4**|**see_that_guy**| -|||| -|**sleeping**
alt: brain|**spiderman**
alt: same|**struggle**
alt: choice, hero| -|||| -|**t_pose**
alt: dominance|**tom_cousins**
alt: cousins, backup|**tough2**
alt: tough, fight| -|||| -|**tough2bis**|**tough3**|**trump**
alt: law| -|||| -|**trust_nobody**
alt: yourself, gun|**truth**
alt: scroll| -||||