about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7755fa4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+PetTheCord
+--
+This is a Web API for petting any user you know which has avatar
+
+## Usage
+`https://example.com/<UserID>.gif` will return you gif that specified user.
+
+To get UserID you should enable developer mode in your client and "Copy User ID"
+option will appear when you do RMB on user.