|
3 | 3 | [](https://www.npmjs.com/package/discord.https) |
4 | 4 | [](LICENSE) |
5 | 5 | [](https://www.npmjs.com/package/discord.https/index.default.html) |
| 6 | +[](https://discordhttps.github.io/discord.https/) |
6 | 7 |
|
7 | 8 | **Discord.https** is a robust, modular library for implementing Discord HTTP interactions. |
8 | 9 |
|
9 | 10 | 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. |
10 | 11 |
|
11 | | -The core is production-ready and can be used in your new http interaction bots. |
| 12 | +The core is production-ready and can be used in your new HTTP interaction bots. |
12 | 13 |
|
13 | 14 | 📄 **Documentation:** [https://discordhttps.github.io/discord.https/](https://discordhttps.github.io/discord.https/) |
14 | 15 |
|
@@ -49,18 +50,41 @@ await client.listen("interactions", 3000, () => { |
49 | 50 | }); |
50 | 51 | ``` |
51 | 52 |
|
| 53 | +## Project Updates |
| 54 | + |
| 55 | +> **Note**: Looking for volunteer contributors! If you are interested, join us on Discord: [https://discord.gg/pSgfJ4K5ej](https://discord.gg/pSgfJ4K5ej) |
| 56 | +
|
| 57 | +> **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. |
| 58 | +
|
| 59 | +> **Note(new)**: 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. |
| 60 | +
|
| 61 | +## Examples |
| 62 | + |
52 | 63 | **You can view example/reference implementations here:** |
53 | 64 |
|
54 | 65 | - Nodejs Runtime: [https://github.com/discordhttps/nodejs-example](https://github.com/discordhttps/nodejs-example) |
55 | 66 | - V8 isolates runtime(Cloudflare Workers): [https://github.com/discordhttps/cloudflare-example](https://github.com/discordhttps/cloudflare-example) |
56 | 67 |
|
57 | | -> **Note**: Looking for volunteer contributors! If you are interested, join us on Discord: [https://discord.gg/pSgfJ4K5ej](https://discord.gg/pSgfJ4K5ej) |
| 68 | +## Installation |
58 | 69 |
|
59 | | -> **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. |
| 70 | +### Node.js |
| 71 | + |
| 72 | +``` |
| 73 | +npm install discord.https @discordhttps/nodejs-adapter |
| 74 | +``` |
| 75 | + |
| 76 | +### Cloudflare |
| 77 | + |
| 78 | +``` |
| 79 | +npm install discord.https @discordhttps/cloudflare-adapter |
| 80 | +``` |
| 81 | + |
| 82 | +## Documentation |
60 | 83 |
|
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. |
| 84 | +- **Discord.https Docs:** [https://discordhttps.github.io/discord.https/](https://discordhttps.github.io/discord.https/) |
| 85 | +- **Discord Interaction Docs:** [Responding to an Interaction](https://discord.com/developers/docs/interactions/receiving-and-responding#responding-to-an-interaction) |
62 | 86 |
|
63 | | -### To do: |
| 87 | +## Todo: |
64 | 88 |
|
65 | 89 | - [ ] Build structures |
66 | 90 | - [ ] Build a simplified `npx create-app` command |
|
0 commit comments