@ardly/bunext 2.0.0 → 2.1.1

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 +120 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,120 @@
1
+ [![Bunext](https://bunext.ardzero.com/ogImage.jpg)](https://bunext.ardzero.com/)
2
+
3
+ # @ardly/bunext (bunext-wrapper)
4
+
5
+ A CLI tool to scaffold the **Bunext** Next.js 16 starter kit configured with Tailwind CSS, Shadcn UI, Tailwind Motion, React Motion, and a bunch of utilities pre-configured.
6
+
7
+ > **Note:** This is a wrapper package for `create-bunext`. For the best experience, use `bun create bunext` instead.
8
+
9
+ ## Quick Start
10
+
11
+ ```bash
12
+ # Recommended (Bun)
13
+ bunx @ardly/bunext my-app
14
+
15
+ # Or with npx
16
+ npx @ardly/bunext my-app
17
+ ```
18
+
19
+ Global install (optional):
20
+
21
+ ```bash
22
+ npm i -g @ardly/bunext
23
+ bunext my-app
24
+ ```
25
+
26
+ ## What This Package Does
27
+
28
+ - **Single entry point** – Run `bunext` (or `bunx @ardly/bunext`) instead of invoking `create-bunext` directly.
29
+ - **No extra config** – Resolves and runs `create-bunext`’s CLI; all flags and behavior are the same.
30
+
31
+ ## CLI Usage
32
+
33
+ Same as **create-bunext**. Examples:
34
+
35
+ ```bash
36
+ # Interactive mode
37
+ bunx @ardly/bunext
38
+
39
+ # Use current directory (must be empty)
40
+ bunx @ardly/bunext .
41
+
42
+ # Quick setup
43
+ bunx @ardly/bunext my-app -y
44
+ bunx @ardly/bunext my-app --cursor
45
+ bunx @ardly/bunext my-app --no-install --no-git
46
+ ```
47
+
48
+ ### Flags (same as create-bunext)
49
+
50
+ | Flag | Description |
51
+ | :--------------------------- | :--------------------------------------------------------- |
52
+ | `-y`, `--yes` | Skip all prompts and use defaults (install deps, init git) |
53
+ | `--install` / `--no-install` | Install or skip installing dependencies |
54
+ | `--git` / `--no-git` | Initialize or skip git repository |
55
+ | `--cursor` | Open project in Cursor after creation |
56
+ | `--vscode` | Open project in VS Code after creation |
57
+ | `-h`, `--help` | Show help message with examples |
58
+ | `-v`, `--version` | Show CLI version |
59
+
60
+ Full help:
61
+
62
+ ```bash
63
+ bunx @ardly/bunext --help
64
+ ```
65
+
66
+ ## Alternative: create-bunext
67
+
68
+ You can also use **create-bunext** directly (e.g. for `bun create bunext`):
69
+
70
+ ```bash
71
+ bun create bunext my-app
72
+ npm create bunext@latest my-app
73
+ ```
74
+
75
+ For full CLI docs, troubleshooting, and template details, see **[create-bunext](../create-bunext/README.md)**.
76
+
77
+ ## What’s Included (Bunext Template)
78
+
79
+ The generated project includes:
80
+
81
+ - **Next.js 16** App Router
82
+ - **Tailwind CSS v4**
83
+ - **Shadcn UI** components
84
+ - **Tailwind Motion** and **React Motion** (`motion.dev`)
85
+ - Dark/light theme, font optimization, **Lucide React**
86
+ - Utilities: metadata, JsonLD, Img, Icons, ogImageGen, featureFlag, clink, code-block, etc.
87
+ - **nuqs** for URL state, SEO helpers, Prettier with Tailwind plugin
88
+
89
+ Live preview and template repo: [github.com/ardzero/bunext](https://github.com/ardzero/bunext)
90
+
91
+ ## Socials
92
+
93
+ - Website: [ardastroid.com](https://ardastroid.com)
94
+ - Email: [hello@ardastroid.com](mailto:hello@ardastroid.com)
95
+ - GitHub: [@ardzero](https://github.com/ardzero)
96
+
97
+ ## License
98
+
99
+ MIT License
100
+
101
+ Copyright (c) 2026
102
+ Farhan Ashhab Nur / [@ardzero](https://github.com/ardzero)
103
+
104
+ Permission is hereby granted, free of charge, to any person obtaining a copy
105
+ of this software and associated documentation files (the "Software"), to deal
106
+ in the Software without restriction, including without limitation the rights
107
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
108
+ copies of the Software, and to permit persons to whom the Software is
109
+ furnished to do so, subject to the following conditions:
110
+
111
+ The above copyright notice and this permission notice shall be included
112
+ in all copies or substantial portions of the Software.
113
+
114
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
115
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
116
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
117
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
118
+ DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
119
+ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
120
+ OTHER DEALINGS IN THE SOFTWARE.
package/package.json CHANGED
@@ -2,14 +2,14 @@
2
2
  "name": "@ardly/bunext",
3
3
  "description": "CLI tool to create Next.js 16 project using Bunext template (wrapper for create-bunext)",
4
4
  "author": "Ard Astroid <ardastroid@gmail.com>",
5
- "version": "2.0.0",
5
+ "version": "2.1.1",
6
6
  "license": "MIT",
7
7
  "repository": {
8
8
  "type": "git",
9
9
  "url": "git+https://github.com/ardzero/bunext.git",
10
10
  "directory": "packages/bunext-wrapper"
11
11
  },
12
- "homepage": "https://bunext.ardastroid.com",
12
+ "homepage": "https://bunext.ardzero.com",
13
13
  "bugs": {
14
14
  "url": "https://github.com/ardzero/bunext/issues"
15
15
  },
@@ -40,6 +40,6 @@
40
40
  "boilerplate"
41
41
  ],
42
42
  "dependencies": {
43
- "create-bunext": "^0.1.0"
43
+ "create-bunext": "^1.0.0"
44
44
  }
45
45
  }