@vercube/h3 0.0.34 → 0.0.35

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 (3) hide show
  1. package/README.md +19 -43
  2. package/dist/index.d.mts +0 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,59 +1,35 @@
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/h3">
11
- <img src="https://img.shields.io/npm/v/%40vercube%2Fh3?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
12
- </a>
13
- <a href="https://www.npmjs.com/package/@vercube/h3">
14
- <img src="https://img.shields.io/npm/dm/%40vercube%2Fh3?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%2Fdi?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>
25
-
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.
6
+ # @vercube/h3
27
7
 
28
- ## <a name="module">H3 Module</a>
8
+ ### H3 integration for Vercube
29
9
 
30
- The H3 module provides integration between Vercube applications and the H3 HTTP framework.
31
- It allows you to:
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%2Fh3?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%2Fh3>)
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>)
32
14
 
33
- - Mount Vercube applications on [H3](https://h3.dev) server
34
- - Use H3's routing capabilities with Vercube's application logic
35
- - Integrate Vercube with other H3-based frameworks
15
+ **Mount your Vercube app on [H3](https://h3.dev) servers. Useful when you need to integrate with Nitro, Nuxt, or other H3-based frameworks.**
36
16
 
37
- ### Basic Usage
17
+ [Website](https://vercube.dev) • [Documentation](https://vercube.dev/docs/getting-started)
38
18
 
39
- ```ts
40
- import { createApp } from '@vercube/core';
41
- import { toH3 } from '@vercube/h3';
42
- import { H3, serve } from 'h3';
19
+ </div>
43
20
 
44
- // Create Vercube app
45
- const app = await createApp();
21
+ ## ✨ Features
46
22
 
47
- // Create H3 server
48
- const h3app = new H3();
23
+ - **Simple adapter** - `toH3(app)` and you're done
24
+ - **Path mounting** - mount at `/api` or any path you want
25
+ - **Mixed routes** - combine H3 routes with Vercube handlers
49
26
 
50
- // Mount Vercube app at /api path
51
- h3app.all('/api/**', toH3(app));
27
+ ## 📦 Installation
52
28
 
53
- // Start the server
54
- await serve(h3app, { port: 3000 });
29
+ ```bash
30
+ pnpm add @vercube/h3
55
31
  ```
56
32
 
57
- ## <a name="documentation">📖 Documentation</a>
33
+ ## 📜 License
58
34
 
59
- 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.
35
+ [MIT](https://github.com/vercube/vercube/blob/main/LICENSE)
package/dist/index.d.mts CHANGED
@@ -2,7 +2,6 @@ import { App } from "@vercube/core";
2
2
  import { EventHandler } from "h3";
3
3
 
4
4
  //#region src/index.d.ts
5
-
6
5
  /**
7
6
  * Converts a Vercube application to an H3 event handler
8
7
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vercube/h3",
3
- "version": "0.0.34",
3
+ "version": "0.0.35",
4
4
  "description": "H3 module for Vercube framework",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,7 +23,7 @@
23
23
  ],
24
24
  "dependencies": {
25
25
  "h3": "beta",
26
- "@vercube/core": "0.0.34"
26
+ "@vercube/core": "0.0.35"
27
27
  },
28
28
  "publishConfig": {
29
29
  "access": "public"