Skip to content

Commit 0206fe3

Browse files
update: README improvements
1 parent 58f30c3 commit 0206fe3

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
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)
55
[![Downloads](https://img.shields.io/npm/dm/discord.https.svg)](https://www.npmjs.com/package/discord.https/index.default.html)
6+
[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://discordhttps.github.io/discord.https/)
67

78
**Discord.https** is a robust, modular library for implementing Discord HTTP interactions.
89

910
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.
1011

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.
1213

1314
📄 **Documentation:** [https://discordhttps.github.io/discord.https/](https://discordhttps.github.io/discord.https/)
1415

@@ -49,18 +50,41 @@ await client.listen("interactions", 3000, () => {
4950
});
5051
```
5152

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+
5263
**You can view example/reference implementations here:**
5364

5465
- Nodejs Runtime: [https://github.com/discordhttps/nodejs-example](https://github.com/discordhttps/nodejs-example)
5566
- V8 isolates runtime(Cloudflare Workers): [https://github.com/discordhttps/cloudflare-example](https://github.com/discordhttps/cloudflare-example)
5667

57-
> **Note**: Looking for volunteer contributors! If you are interested, join us on Discord: [https://discord.gg/pSgfJ4K5ej](https://discord.gg/pSgfJ4K5ej)
68+
## Installation
5869

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
6083

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)
6286

63-
### To do:
87+
## Todo:
6488

6589
- [ ] Build structures
6690
- [ ] Build a simplified `npx create-app` command

0 commit comments

Comments
 (0)