create-vercube 0.0.34 → 0.0.41

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 +32 -43
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,59 +1,48 @@
1
1
  <div align="center">
2
- <a href="https://vercube.dev/"><img src="https://github.com/OskarLebuda/vue-lazy-hydration/raw/main/.github/assets/logo.png?raw=true" alt="Vite logo" width="200"></a>
2
+ <img src="https://raw.githubusercontent.com/vercube/vercube/refs/heads/main/.github/assets/cover.png" width="100%" alt="Vercube - Unleash your server development." />
3
3
  <br>
4
4
  <br>
5
5
 
6
- # Vercube
7
-
8
- Next generation HTTP framework
9
-
10
- <a href="https://www.npmjs.com/package/create-vercube">
11
- <img src="https://img.shields.io/npm/v/create-vercube?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
12
- </a>
13
- <a href="https://www.npmjs.com/package/@vercube/create-app">
14
- <img src="https://img.shields.io/npm/dm/create-vercube?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
15
- </a>
16
- <a href="https://github.com/vercube/vercube/blob/main/LICENSE" target="_blank">
17
- <img src="https://img.shields.io/npm/l/create-vercube?style=for-the-badge&color=%23767eff" alt="License"/>
18
- </a>
19
- <a href="https://codecov.io/gh/vercube/vercube" target="_blank">
20
- <img src="https://img.shields.io/codecov/c/github/vercube/vercube?style=for-the-badge&color=%23767eff" alt="Coverage"/>
21
- </a>
22
- <br/>
23
- <br/>
24
- </div>
6
+ # create-vercube
25
7
 
26
- An ultra-efficient JavaScript server framework that runs anywhere - Node.js, Bun, or Deno - with unmatched flexibility and complete configurability for developers who refuse to sacrifice speed or control.
8
+ ### Scaffold a new Vercube project
27
9
 
28
- ## <a name="getting-started">🚀 Quick Start</a>
10
+ [![Ask DeepWiki](<https://img.shields.io/badge/ask-deepwiki-%20blue?style=for-the-badge&logo=bookstack&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232f2f2f>)](https://deepwiki.com/vercube/vercube)
11
+ ![NPM Version](<https://img.shields.io/npm/v/create-vercube?style=for-the-badge&logo=npm&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232e2e2e&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fcreate-vercube>)
12
+ ![GitHub License](<https://img.shields.io/github/license/vercube/vercube?style=for-the-badge&logo=gitbook&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232f2f2f>)
13
+ ![Codecov](<https://img.shields.io/codecov/c/github/vercube/vercube?style=for-the-badge&logo=vitest&logoColor=rgba(255%2C%20255%2C%20255%2C%200.6)&labelColor=%23000&color=%232f2f2f>)
29
14
 
30
- Vercube makes it incredibly easy to get started. With just one command, you'll have a fully configured project ready for development:
15
+ **The fastest way to start a new Vercube project. One command and you're ready to code.**
31
16
 
32
- ```sh
33
- $ pnpm create vercube@latest
34
- ```
17
+ [Website](https://vercube.dev) • [Documentation](https://vercube.dev/docs/getting-started)
18
+
19
+ </div>
35
20
 
36
- You can also try Vercube instantly using our online templates:
21
+ ## 🚀 Usage
37
22
 
38
- <a href="https://stackblitz.com/edit/vercube-starter" target="_blank">
39
- <img src="https://img.shields.io/badge/Open%20in-StackBlitz-blue?style=for-the-badge&logo=stackblitz" alt="Open in StackBlitz">
40
- </a>
41
- <a href="https://codesandbox.io/p/devbox/vercube-starter-97s34j" target="_blank">
42
- <img src="https://img.shields.io/badge/Open%20in-CodeSandbox-blue?style=for-the-badge&logo=codesandbox" alt="Open in CodeSandbox">
43
- </a>
23
+ ```bash
24
+ # pnpm
25
+ pnpm create vercube@latest
44
26
 
45
- ## <a name="documentation">📖 Documentation</a>
27
+ # npm
28
+ npx create-vercube@latest
46
29
 
47
- Comprehensive documentation is available at [vercube.dev](https://vercube.dev). There you'll find detailed module descriptions, project information, guides, and everything else you need to know about Vercube.
30
+ # bun
31
+ bun create vercube
32
+ ```
33
+
34
+ Then just:
35
+
36
+ ```bash
37
+ cd my-app
38
+ pnpm install
39
+ pnpm dev
40
+ ```
48
41
 
49
- ## <a name="contribute">❤️ Contribute</a>
42
+ ## 📖 Documentation
50
43
 
51
- We welcome and appreciate all contributions to Vercube! There are several ways you can help make this project better:
44
+ Check out the full docs at **[vercube.dev](https://vercube.dev)**
52
45
 
53
- - **Report bugs**: If you find a bug, please [open an issue](https://github.com/vercube/vercube/issues) with detailed steps to reproduce it
54
- - **Submit pull requests**: Have a fix or new feature? PRs are always welcome! Check out our [contribution guidelines](CONTRIBUTING.md)
55
- - **Join our community**: Have questions or want to discuss ideas? Join our [Discord server](https://discord.gg/safphS45aN)
56
- - **Improve documentation**: Found something unclear or missing in the docs? Help us make them better!
57
- - **Share feedback**: Your input helps shape Vercube's future. Let us know what features you'd like to see
46
+ ## 📜 License
58
47
 
59
- Every contribution, no matter how small, makes a difference. We strive to review all contributions promptly and maintain a welcoming environment for all contributors.
48
+ [MIT](https://github.com/vercube/vercube/blob/main/LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-vercube",
3
- "version": "0.0.34",
3
+ "version": "0.0.41",
4
4
  "description": "Create a Vercube app in seconds",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -17,6 +17,6 @@
17
17
  "README.md"
18
18
  ],
19
19
  "dependencies": {
20
- "@vercube/cli": "0.0.34"
20
+ "@vercube/cli": "0.0.41"
21
21
  }
22
22
  }