summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
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.