shoukaku-bun 4.2.0-b → 4.2.0-c

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 +29 -11
  2. package/package.json +16 -7
package/README.md CHANGED
@@ -1,12 +1,13 @@
1
1
  ## Shoukaku-Bun
2
2
 
3
- > Powerfull, Lightweight wrapper around Lavalink
3
+ [![Sponsor](https://img.shields.io/github/sponsors/LuigiColantuono?style=social)](https://github.com/sponsors/LuigiColantuono)
4
+ [![PayPal](https://img.shields.io/badge/💖-Support-ff69b4)](https://paypal.me/l0g4n7)
5
+ [![npm](https://img.shields.io/npm/v/shoukaku-bun?style=flat-square)](https://www.npmjs.com/package/shoukaku-bun)
6
+ ![Github Stars](https://img.shields.io/github/stars/LuigiColantuono/Shoukaku-Bun?style=flat-square)
7
+ ![GitHub issues](https://img.shields.io/github/issues-raw/LuigiColantuono/Shoukaku-Bun?style=flat-square)
8
+ ![NPM](https://img.shields.io/npm/l/shoukaku-bun?style=flat-square)
4
9
 
5
- [![Discord](https://img.shields.io/discord/423116740810244097?style=flat-square)](https://discordapp.com/invite/FVqbtGu)
6
- [![npm](https://img.shields.io/npm/v/shoukaku?style=flat-square)](https://www.npmjs.com/package/shoukaku)
7
- ![Github Stars](https://img.shields.io/github/stars/Deivu/Shoukaku?style=flat-square)
8
- ![GitHub issues](https://img.shields.io/github/issues-raw/Deivu/Shoukaku?style=flat-square)
9
- ![NPM](https://img.shields.io/npm/l/shoukaku?style=flat-square)
10
+ > Powerful, Lightweight wrapper around Lavalink
10
11
 
11
12
  <p align="center">
12
13
  <img src="https://azurlane.netojuu.com/images/thumb/d/dc/ShoukakuWeddingWithoutBG.png/767px-ShoukakuWeddingWithoutBG.png">
@@ -21,19 +22,36 @@
21
22
  - **Stable & Updated**: Based on the rock-solid Shoukaku v4.2.0 logic.
22
23
  - **Very cute (Very Important)**
23
24
 
24
- ### Documentation
25
+ ## 📦 Bundle Size Comparison
25
26
 
26
- > https://guide.shoukaku.shipgirl.moe/
27
+ | Package | Size | Dependencies | Total Install |
28
+ |---------|------|--------------|---------------|
29
+ | shoukaku | 366 kB | ws (~300 kB) | **~666 kB** |
30
+ | shoukaku-bun | 72.9 kB | **NONE** | **72.9 kB** |
31
+
32
+ **89% smaller install size!** 🚀
33
+
34
+ ## 🎵 The Story
35
+
36
+ Built out of frustration with constant WebSocket upgrade warnings that were
37
+ making my Discord music bot laggy. After migrating to Bun, I realized the
38
+ entire Shoukaku stack could be rewritten to be faster and lighter.
39
+
40
+ **Result?** Zero warnings. Noticeably faster. Way more fun to work with.
41
+
42
+ If this solved your problems too, [consider supporting the project](https://paypal.me/tuonome)!
43
+ Even a coffee helps keep the motivation high! ☕
27
44
 
28
45
  ### Installation
29
46
 
30
47
  This is a specialized fork. Install it directly from GitHub:
31
48
 
32
49
  ```bash
33
- bun add github:LuigiColantuono/shoukaku-bun
50
+ bun add shoukaku-bun
34
51
  ```
35
52
 
36
- ### Documentation
53
+
54
+ ### Official Documentation
37
55
 
38
56
  > https://guide.shoukaku.shipgirl.moe/
39
57
 
@@ -74,7 +92,7 @@ new Shoukaku(new Connectors.DiscordJS(client), Nodes, Options);
74
92
 
75
93
  | Name | Link | Description |
76
94
  | -------- | --------------------------------------------- | -------------------------------------------------------- |
77
- | Kazagumo | [Github](https://github.com/Takiyo0/Kazagumo) | A wrapper for Shoukaku that has an internal queue system |
95
+ | Kazagumo-Bun | [Github](https://github.com/uigiColantuono/Kazagumo-Bun) | A wrapper for Shoukaku that has an internal queue system |
78
96
 
79
97
  > Open a pr if you want to add a wrapper here
80
98
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoukaku-bun",
3
- "version": "4.2.0-b",
3
+ "version": "4.2.0-c",
4
4
  "description": "Bun-native high-performance fork of Shoukaku. Node-dependencies purged.",
5
5
  "main": "index.ts",
6
6
  "module": "index.ts",
@@ -26,24 +26,33 @@
26
26
  "lavalink",
27
27
  "bun",
28
28
  "high-performance",
29
- "discord"
29
+ "discord",
30
+ "websocket",
31
+ "zero-dependencies",
32
+ "typescript"
30
33
  ],
31
34
  "engines": {
32
- "bun": "1.3.6"
35
+ "bun": ">=1.3.6"
33
36
  },
34
37
  "author": "Saya",
35
38
  "contributors": [
36
39
  {
37
40
  "name": "Luigi Colantuono",
38
- "url": "https://github.com/LuigiColantuono",
39
- "info": "Bun Refactor & Optimization"
41
+ "url": "https://github.com/LuigiColantuono"
40
42
  }
41
43
  ],
42
44
  "license": "MIT",
43
- "homepage": "https://github.com/LuigiColantuono/shoukaku-bun",
45
+ "homepage": "https://github.com/LuigiColantuono/Shoukaku-Bun#readme",
44
46
  "repository": {
45
47
  "type": "git",
46
- "url": "git+https://github.com/LuigiColantuono/shoukaku-bun.git"
48
+ "url": "git+https://github.com/LuigiColantuono/Shoukaku-Bun.git"
49
+ },
50
+ "bugs": {
51
+ "url": "https://github.com/LuigiColantuono/Shoukaku-Bun/issues"
52
+ },
53
+ "funding": {
54
+ "type": "individual",
55
+ "url": "https://paypal.me/l0g4n7"
47
56
  },
48
57
  "dependencies": {},
49
58
  "devDependencies": {