@vercube/core 0.0.34 → 0.0.36

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.
package/README.md CHANGED
@@ -1,59 +1,41 @@
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/@vercube/core">
11
- <img src="https://img.shields.io/npm/v/%40vercube%2Fcore?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
12
- </a>
13
- <a href="https://www.npmjs.com/package/@vercube/core">
14
- <img src="https://img.shields.io/npm/dm/%40vercube%2Fcore?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/%40vercube%2Fcore?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
+ # @vercube/core
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
+ ### Core framework for building HTTP APIs
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/%40vercube%2Fcore?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%2F%40vercube%2Fcore>)
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 heart of Vercube - everything you need to build fast, type-safe APIs with decorators, dependency injection, and validation.**
31
16
 
32
- ```sh
33
- $ pnpm create vercube@latest
34
- ```
17
+ [Website](https://vercube.dev) • [Documentation](https://vercube.dev/docs/getting-started)
35
18
 
36
- You can also try Vercube instantly using our online templates:
19
+ </div>
37
20
 
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>
21
+ ## Features
44
22
 
45
- ## <a name="documentation">📖 Documentation</a>
23
+ - **Declarative Routing** - define endpoints with `@Controller`, `@Get`, `@Post` and friends
24
+ - **Dependency Injection** - built-in IoC container, just `@Inject` what you need
25
+ - **Validation** - works with Zod, Valibot, ArkType out of the box
26
+ - **Middleware** - hook into request/response lifecycle
27
+ - **Runtime Agnostic** - runs on Node.js, Bun, and Deno
46
28
 
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.
29
+ ## 📦 Installation
30
+
31
+ ```bash
32
+ pnpm add @vercube/core
33
+ ```
48
34
 
49
- ## <a name="contribute">❤️ Contribute</a>
35
+ ## 📖 Usage
50
36
 
51
- We welcome and appreciate all contributions to Vercube! There are several ways you can help make this project better:
37
+ Check out the full [documentation](https://vercube.dev/docs/getting-started/installation)
52
38
 
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
39
+ ## 📜 License
58
40
 
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.
41
+ [MIT](https://github.com/vercube/vercube/blob/main/LICENSE)