@lunora/nuxt 1.0.0-alpha.2 → 1.0.0-alpha.20

package/LICENSE.md

@@ -103,3 +103,9 @@ Unless required by applicable law or agreed to in writing, software distributed
 under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
+
+<!-- DEPENDENCIES -->
+<!-- /DEPENDENCIES -->
+
+<!-- TYPE_DEPENDENCIES -->
+<!-- /TYPE_DEPENDENCIES -->

package/README.md

@@ -1,4 +1,38 @@
-# @lunora/nuxt
+<!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
+
+<a href="https://www.anolilab.com/open-source" align="center">
+
+  <img src="__assets__/package-og.svg" alt="nuxt" />
+
+</a>
+
+<h3 align="center">Nuxt module for Lunora — single-worker composition (mounts /_lunora/* into Nitro) plus reactive-loader server helpers</h3>
+
+<!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
+
+<br />
+
+<div align="center">
+
+[![typescript-image][typescript-badge]][typescript-url]
+[![FSL-1.1-Apache-2.0 licence][license-badge]][license]
+[![npm version][npm-version-badge]][npm-version]
+[![npm downloads][npm-downloads-badge]][npm-downloads]
+[![PRs Welcome][prs-welcome-badge]][prs-welcome]
+
+</div>
+
+---
+
+<div align="center">
+    <p>
+        <sup>
+            Daniel Bannert's open source work is supported by the community on <a href="https://github.com/sponsors/prisis">GitHub Sponsors</a>
+        </sup>
+    </p>
+</div>
+
+---
 
 A **Nuxt module** that runs Lunora and Nuxt as a **single Cloudflare Worker**.
 
@@ -7,6 +41,8 @@ is mounted _inside_ Nitro: the module registers a server route at `/_lunora/**`
 that forwards every Lunora RPC, WebSocket upgrade, and admin request to your
 Lunora app in-process. One `wrangler.jsonc`, one deploy, a same-origin client.
 
+Part of the [Lunora](https://github.com/anolilab/lunora) framework — a type-safe, real-time backend on Cloudflare Workers + Durable Objects with a Vite-first DX.
+
 ## Install
 
 ```bash
@@ -78,3 +114,64 @@ Single-worker composition rides on two Nitro behaviours that vary across version
 (`createServerClient`, `preloadQuery`, …) from `@lunora/client/ssr` for the
 reactive-loader handoff. Safe to import from a Nitro server route (no WebSocket,
 no browser globals).
+
+## Feature flags
+
+`@lunora/nuxt` ships no flag composable — Nuxt _is_ Vue, so read `ctx.flags`
+server-side (a Nitro route, a function, or a reactive loader) and pass the
+resolved value down, or call `useFlag` / `useFlags` from
+[`@lunora/vue`](https://www.npmjs.com/package/@lunora/vue) directly in a
+component for live updates over the WebSocket. Requires
+[`@lunora/flags`](https://www.npmjs.com/package/@lunora/flags) wired in
+`lunora/flags.ts`.
+
+```vue
+<script setup lang="ts">
+import { useFlag } from "@lunora/vue";
+
+// Live over the Lunora WS — holds `false` until the server resolves it.
+const newHero = useFlag("homepage-hero", false);
+</script>
+
+<template>
+    <NewHero v-if="newHero" />
+    <ClassicHero v-else />
+</template>
+```
+
+## Supported Node.js Versions
+
+Libraries in this ecosystem make the best effort to track [Node.js' release schedule](https://github.com/nodejs/release#release-schedule).
+Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
+
+## Contributing
+
+If you would like to help take a look at the [list of issues](https://github.com/anolilab/lunora/issues) and check our [Contributing](https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md) guidelines.
+
+> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+## Credits
+
+- [Daniel Bannert](https://github.com/prisis)
+- [All Contributors](https://github.com/anolilab/lunora/graphs/contributors)
+
+## Made with ❤️ at Anolilab
+
+This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
+
+## License
+
+The Lunora nuxt package is open-sourced software licensed under the [FSL-1.1-Apache-2.0][license].
+
+<!-- badges -->
+
+[license-badge]: https://img.shields.io/badge/license-FSL--1.1--Apache--2.0-blue.svg?style=for-the-badge
+[license]: https://github.com/anolilab/lunora/blob/alpha/LICENSE.md
+[npm-version-badge]: https://img.shields.io/npm/v/@lunora/nuxt?style=for-the-badge
+[npm-version]: https://www.npmjs.com/package/@lunora/nuxt
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/nuxt?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@lunora/nuxt
+[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+[prs-welcome]: https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md
+[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: https://www.typescriptlang.org/