summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormsglm <msglm@techchud.xyz>2023-01-17 05:57:43 -0600
committermsglm <msglm@techchud.xyz>2023-01-17 05:57:43 -0600
commit65b7abadb42e8b9681b978cdda52f6d650027c86 (patch)
tree96e675730d00572704f089a355b630356c8da5ce /README.md
parentdcadc536f3d279527e58f68d6a4b05e79436d06e (diff)
downloadcomedyGenerator-62e1cd4e5220edee076935451d01f4b879223b4c.tar.gz
comedyGenerator-62e1cd4e5220edee076935451d01f4b879223b4c.tar.bz2
comedyGenerator-62e1cd4e5220edee076935451d01f4b879223b4c.zip
improved documentationv1.0.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 97c1e7e..dfc4412 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,6 @@
-<h1>Comedy Generator</h1>
-<p>shitty meme scrapper for funny internet website</p>
+# Comedy Generator
+Ifunny API scrapper for downloading videos and gifs.
+
+# Usage
+All configuration is done in a TOML file that you can find named `config`. You can also run `comedyGenerator --help` to get a general idea for how the tool works.