Update README.md

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md

index c7095453..3439a95d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # discord-cdn
 cdn for discord clone
+
+## Endpoints:
+
+### /external 
+#### POST
+```
+Content-Type: application/json
+
+body:
+{"url": URL}                  // "https://discord.com"
+```
+##### Returns:
+Content-Type: application/json
+```ts
+{
+    "id": string,             // "aHR0cHM6Ly9kaXNjb3JkLmNvbQ=="
+    "ogTitle": string,        // "Discord | Your Place to Talk and Hang Out"
+    "ogDescription": string,  // "Discord is the easiest way to talk over voice, video, and text. Talk, chat, hang out, and stay close with your friends and communities."
+    "cachedImage": string,    // "/external/aHR0cHM6Ly9kaXNjb3JkLmNvbQ==/discord.png"
+    "ogUrl": string,          // "https://discord.com/"
+    "ogType": string          // "website"
+}
+```
+### /external/:id/:filename
+#### GET