Skip to content

Commit d887cb5

Browse files
committed
docs: update READMEs with badges and enhanced information
Adds sponsorship and social media badges across all package READMEs. Introduces npm package stats badges for the `app-extension` and `ui` packages. Refines the `docs` README with clearer development, build, and check instructions. Includes a critical note in the `app-extension` README regarding webpack incompatibility for v3.
1 parent 893b54b commit d887cb5

5 files changed

Lines changed: 60 additions & 12 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/quasarframework/quasar-ui-qwindow.svg)](https://github.com/quasarframework/quasar-ui-qwindow)
77
[![GitHub repo size in bytes](https://img.shields.io/github/repo-size/quasarframework/quasar-ui-qwindow.svg)](https://github.com/quasarframework/quasar-ui-qwindow)
88

9+
<span class="badge-github-sponsors"><a href="https://github.com/sponsors/hawkeye64" title="Sponsor this project on GitHub"><img src="https://img.shields.io/badge/github-sponsors-ea4aaa.svg?logo=githubsponsors&logoColor=white" alt="GitHub Sponsors button" /></a></span>
10+
<span class="badge-paypal"><a href="https://paypal.me/hawkeye64" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
11+
12+
[![Discord](https://img.shields.io/badge/discord-join%20server-738ADB?style=for-the-badge&logo=discord&logoColor=738ADB)](https://chat.quasar.dev)
13+
[![X](https://img.shields.io/badge/follow-@jgalbraith64-1DA1F2?style=for-the-badge&logo=x&logoColor=1DA1F2)](https://twitter.com/jgalbraith64)
14+
915
QWindow is a Quasar component and app extension for building floating, movable, and resizable window
1016
panels. It is useful for desktop-style workspaces, inspectors, tool palettes, and dashboards where
1117
users need to keep multiple panels open at once.

packages/app-extension/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# QWindow App Extension
22

3+
[![npm version](https://img.shields.io/npm/v/@quasar/quasar-app-extension-qwindow?label=%40quasar%2Fquasar-app-extension-qwindow)](https://www.npmjs.com/package/@quasar/quasar-app-extension-qwindow)
4+
[![npm downloads](https://img.shields.io/npm/dt/@quasar/quasar-app-extension-qwindow)](https://www.npmjs.com/package/@quasar/quasar-app-extension-qwindow)
5+
[![npm monthly downloads](https://img.shields.io/npm/dm/@quasar/quasar-app-extension-qwindow)](https://www.npmjs.com/package/@quasar/quasar-app-extension-qwindow)
6+
[![license](https://img.shields.io/npm/l/@quasar/quasar-app-extension-qwindow)](https://www.npmjs.com/package/@quasar/quasar-app-extension-qwindow)
7+
8+
<span class="badge-github-sponsors"><a href="https://github.com/sponsors/hawkeye64" title="Sponsor this project on GitHub"><img src="https://img.shields.io/badge/github-sponsors-ea4aaa.svg?logo=githubsponsors&logoColor=white" alt="GitHub Sponsors button" /></a></span>
9+
<span class="badge-paypal"><a href="https://paypal.me/hawkeye64" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
10+
11+
[![Discord](https://img.shields.io/badge/discord-join%20server-738ADB?style=for-the-badge&logo=discord&logoColor=738ADB)](https://chat.quasar.dev)
12+
[![X](https://img.shields.io/badge/follow-@jgalbraith64-1DA1F2?style=for-the-badge&logo=x&logoColor=1DA1F2)](https://twitter.com/jgalbraith64)
13+
314
The QWindow app extension (`@quasar/quasar-app-extension-qwindow`) installs and registers the
415
[QWindow UI](https://github.com/quasarframework/quasar-ui-qwindow/tree/v3-beta/packages/ui)
516
component for Quasar CLI Vite applications.
617

7-
![@quasar/quasar-app-extension-qwindow](https://img.shields.io/npm/v/@quasar/quasar-app-extension-qwindow?label=@quasar/quasar-app-extension-qwindow)
8-
[![npm](https://img.shields.io/npm/dt/@quasar/quasar-app-extension-qwindow.svg)](https://www.npmjs.com/package/@quasar/quasar-app-extension-qwindow)
9-
1018
## Install
1119

1220
```bash
@@ -18,6 +26,9 @@ quasar ext add @quasar/qwindow
1826
- Quasar v2.
1927
- `@quasar/app-vite` >=3.0.0-rc.5.
2028

29+
QWindow v3 does not support webpack-based Quasar apps. If your application is still using
30+
`@quasar/app-webpack`, migrate the app to Quasar CLI Vite before installing this app extension.
31+
2132
## Uninstall
2233

2334
```bash

packages/docs/README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,47 @@
11
# QWindow Docs
22

3-
Documentation and examples for QWindow.
3+
<span class="badge-github-sponsors"><a href="https://github.com/sponsors/hawkeye64" title="Sponsor this project on GitHub"><img src="https://img.shields.io/badge/github-sponsors-ea4aaa.svg?logo=githubsponsors&logoColor=white" alt="GitHub Sponsors button" /></a></span>
4+
<span class="badge-paypal"><a href="https://paypal.me/hawkeye64" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
45

5-
## Install
6+
[![Discord](https://img.shields.io/badge/discord-join%20server-738ADB?style=for-the-badge&logo=discord&logoColor=738ADB)](https://chat.quasar.dev)
7+
[![X](https://img.shields.io/badge/follow-@jgalbraith64-1DA1F2?style=for-the-badge&logo=x&logoColor=1DA1F2)](https://twitter.com/jgalbraith64)
68

7-
```bash
8-
pnpm install
9-
```
9+
This package contains the Q-Press documentation site for QWindow. It owns the public documentation source, live demos, example-viewer content, generated API pages, and static-search output for windowing components and desktop-like interaction examples.
10+
11+
The docs app is a Quasar CLI Vite project inside the monorepo. Production docs should be built from the repository root so the UI package, app extension, generated API data, Q-Press route checks, and static output all describe the same release candidate.
1012

1113
## Development
1214

15+
From the repository root:
16+
1317
```bash
14-
pnpm dev
18+
pnpm install
19+
pnpm build:ui
20+
pnpm --filter docs dev
1521
```
1622

1723
## Build
1824

25+
Build the full release set, including docs:
26+
1927
```bash
2028
pnpm build
2129
```
2230

23-
## Typecheck
31+
Build only the docs site after the UI package is already current:
32+
33+
```bash
34+
pnpm build:docs
35+
```
36+
37+
The docs package runs `quasar build` and `qpress ssg`; production output is emitted to `packages/docs/dist/spa`.
38+
39+
## Checks
40+
41+
Useful repository-level checks for docs work:
2442

2543
```bash
26-
pnpm typecheck
44+
pnpm api:check
45+
pnpm check:qpress
46+
pnpm --filter docs typecheck
2747
```

packages/docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@
5555
"pnpm": ">=11.5.0"
5656
},
5757
"productName": "QWindow Docs"
58-
}
58+
}

packages/ui/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# QWindow UI
22

3+
[![npm version](https://img.shields.io/npm/v/@quasar/quasar-ui-qwindow?label=%40quasar%2Fquasar-ui-qwindow)](https://www.npmjs.com/package/@quasar/quasar-ui-qwindow)
4+
[![npm downloads](https://img.shields.io/npm/dt/@quasar/quasar-ui-qwindow)](https://www.npmjs.com/package/@quasar/quasar-ui-qwindow)
5+
[![npm monthly downloads](https://img.shields.io/npm/dm/@quasar/quasar-ui-qwindow)](https://www.npmjs.com/package/@quasar/quasar-ui-qwindow)
6+
[![license](https://img.shields.io/npm/l/@quasar/quasar-ui-qwindow)](https://www.npmjs.com/package/@quasar/quasar-ui-qwindow)
7+
8+
<span class="badge-github-sponsors"><a href="https://github.com/sponsors/hawkeye64" title="Sponsor this project on GitHub"><img src="https://img.shields.io/badge/github-sponsors-ea4aaa.svg?logo=githubsponsors&logoColor=white" alt="GitHub Sponsors button" /></a></span>
9+
<span class="badge-paypal"><a href="https://paypal.me/hawkeye64" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
10+
11+
[![Discord](https://img.shields.io/badge/discord-join%20server-738ADB?style=for-the-badge&logo=discord&logoColor=738ADB)](https://chat.quasar.dev)
12+
[![X](https://img.shields.io/badge/follow-@jgalbraith64-1DA1F2?style=for-the-badge&logo=x&logoColor=1DA1F2)](https://twitter.com/jgalbraith64)
13+
314
QWindow is a Quasar component for building floating, movable, and resizable window panels.
415

516
## Install

0 commit comments

Comments
 (0)