Skip to content

Commit ab716fe

Browse files
update: README improvements
1 parent 96b653b commit ab716fe

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
[![npm version](https://img.shields.io/npm/v/discord.https.svg)](https://www.npmjs.com/package/discord.https)
44
[![License](https://img.shields.io/npm/l/discord.https.svg)](LICENSE)
5-
[![Downloads](https://img.shields.io/npm/dm/discord.https.svg)](https://www.npmjs.com/package/discord.https)
5+
[![Downloads](https://img.shields.io/npm/dm/discord.https.svg)](https://www.npmjs.com/package/discord.https/index.default.html)
66

77
**Discord.https** is a robust, modular library for implementing Discord HTTP interactions.
88

99
It handles various interactions and organizes them into modular routes, making your bot's code cleaner, easier to understand, and easier to maintain. It works seamlessly in both serverless and persistent server environments.
1010

1111
The core is production-ready and can be used in your new http interaction bots.
1212

13+
📄 **Documentation:** [https://discordhttps.github.io/discord.https/](https://discordhttps.github.io/discord.https/)
14+
1315
```js
14-
import Client from "discord.https";
16+
import Client, { InteractionResponseType } from "discord.https";
1517
import NodeAdapter from "@discordhttps/nodejs-adapter";
16-
import { InteractionResponseType } from "discord-api-types/v10";
1718

1819
const client = new Client({
1920
token: "YOUR BOT TOKEN",
@@ -57,10 +58,12 @@ await client.listen("interactions", 3000, () => {
5758
5859
> **Note**: Utility methods such as <interaction>.editReply() and <interaction>.deferReply() are currently in development, so you won’t need to manually handle the raw response object in the future.
5960
61+
> **Note**: Utility methods were initially planned to closely follow Discord.js. However, since HTTP interactions are mostly used in a serverless environment, instead of having many layers of objects like Discord.js, an Eris-like approach will be adopted to keep the utilities minimal and lightweight.
62+
6063
### To do:
6164

62-
- [ ] Build structures → reference: [discord.js - structures](https://github.com/discordjs/discord.js/tree/main/packages/discord.js/src/structures)
63-
- [ ] Build a simplified `npx create-app` command [in progress]
65+
- [ ] Build structures
66+
- [ ] Build a simplified `npx create-app` command
6467
- [ ] Implement tests
6568
- [x] HTTP adapters to support all hosting environments. Currently implemented: Node.js adapter for [Node.js runtime](https://github.com/discord-http/nodejs-adapter) and [Cloudflare adapter for V8 isolates runtime](https://github.com/discord-http/cloudflare-adapter)
66-
- [x] Examples [will be published soon]
69+
- [x] Examples

0 commit comments

Comments
 (0)