1 files changed, 15 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1dfc278
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Proxy for discord avatars.
+
+This program allows you to proxy discord avatars so that they are always up to date.
+
+Run: 
+
+    TOKEN=<discordtoken> PORT=3000 cargo run 
+
+Listens to localhost:<port>
+
+Requests to localhost:<port>/avatar/<userid> instead reply with a png of the users avatar.
+
+A publicly hosted version is available at https://dp.nea.moe/avatar/310702108997320705
+
+