Skip to content

Commit 9866acf

Browse files
committed
chore: add readme
1 parent 45e88d8 commit 9866acf

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<p align="center">
2+
<img src="https://bot.embeds.media/og.jpg" alt="Embedly" />
3+
</p>
4+
5+
<h1 align="center">Embedly</h1>
6+
7+
<p align="center">
8+
<em>The missing link between social media and Discord.</em>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://bot.embeds.media/invite">Invite to Discord</a>
13+
·
14+
<a href="https://bot.embeds.media/docs">Documentation</a>
15+
·
16+
<a href="https://bot.embeds.media">Website</a>
17+
</p>
18+
19+
---
20+
21+
## Share links that actually work, the way they should be.
22+
23+
Embedly replaces Discord's broken native embeds with rich, accurate ones. Paste a supported link in any server or DM and Embedly fetches the content directly: media, stats, reply chains, quote posts, all rendered with Discord's component system.
24+
25+
## Using Embedly
26+
27+
There are three ways to trigger an embed.
28+
29+
### Messages
30+
31+
Embedly automatically detects and embeds links as they're posted, no command needed. Multiple links in a single message are all processed. The first link gets a reply, and each additional link is sent as a follow-up in the same channel. Once Embedly has posted, Discord's native embed preview is suppressed.
32+
33+
If a link is wrapped in Discord spoiler tags, the embed is spoilered too. Wrap a link in angle brackets to prevent Embedly from embedding it.
34+
35+
### Slash command
36+
37+
Use `/embed` with a URL and optional display flags to manually create a rich embed from any supported link. Available in servers, DMs, and group DMs.
38+
39+
```
40+
/embed url:<link> [media_only] [source_only] [spoiler]
41+
```
42+
43+
| Option | Description |
44+
| --- | --- |
45+
| `url` | The link to embed. Must be from a supported platform. |
46+
| `media_only` | Show only the media, with no text, author, or stats. |
47+
| `source_only` | Show only the source post. Hides any quoted or replied-to content. |
48+
| `spoiler` | Wrap the embed in a spoiler. Users must click to reveal it. |
49+
50+
### Context menu
51+
52+
Right-click any existing message (or long-press on mobile), then go to **Apps → Embed Links**. Useful if Embedly missed a link, or the message predates Embedly being in the server.
53+
54+
## Supported platforms
55+
56+
| Platform | What it embeds |
57+
| --- | --- |
58+
| **Twitter / X** | Tweets, quote tweets, reply chains, and articles. Images, video, and GIFs. |
59+
| **Instagram** | Posts, reels, stories, and carousels. |
60+
| **Reddit** | Posts with text, images, galleries, and video. |
61+
| **Threads** | Posts with text, images, carousels, and video. |
62+
| **TikTok** | Videos with caption and stats. |
63+
64+
See the [platforms docs](https://bot.embeds.media/docs/platforms) for full details on what each platform supports.
65+
66+
## License
67+
68+
[Elastic License 2.0](./LICENSE).

0 commit comments

Comments
 (0)