guilds.js 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,5 +1,9 @@
1
1
  <p align="center">
2
- <img src="public/logo.png" alt="guilds.js Logo" width="85" />
2
+ <img
3
+ alt="guilds.js Logo"
4
+ width="85"
5
+ src="https://cdn.discordapp.com/attachments/1025091872198250597/1475481054004646100/guildslogo1.png?ex=699da450&is=699c52d0&hm=57ded16ddbafe1b094a44e78b1ae5ea2e3c647bd2b830c44354b6e11e6ecf0c5&"
6
+ />
3
7
  </p>
4
8
 
5
9
  <div align="center">
@@ -25,7 +29,23 @@ bun add guilds.js
25
29
  ## Example
26
30
 
27
31
  ```js
28
- // Coming soon...
32
+ import { Client } from "guilds.js";
33
+
34
+ const client = new Client({
35
+ // https://discord.com/developers/applications
36
+ token: "bot token",
37
+
38
+ // client intents (as a number)
39
+ // example (guilds, guild messages, guild members):
40
+ intents: 515,
41
+ });
42
+
43
+ client.once("ready", () => {
44
+ console.log("Client is ready!");
45
+ });
46
+
47
+ // start connection to Discord gateway
48
+ client.connect();
29
49
  ```
30
50
 
31
51
  # Contributing
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "guilds.js",
3
3
  "description": "Interact with Discord's API with ease",
4
- "version": "0.0.1",
4
+ "version": "0.0.3",
5
5
  "license": "Apache-2.0",
6
6
  "exports": {
7
7
  "default": "./dist/index.cjs",
@@ -46,7 +46,7 @@
46
46
  },
47
47
  "repository": {
48
48
  "type": "git",
49
- "url": "https://github.com/andrewdku/guilds"
49
+ "url": "https://github.com/andrewdku/guilds.js"
50
50
  },
51
51
  "publishConfig": {
52
52
  "access": "public"