bref-ui-themes 1.0.0 → 1.0.1

package/README.md

@@ -1,16 +1,35 @@
-# bref-ui-themes
+# Bref-ui themes
 
-Reusable themes for [Bref-ui](../readme.md), each intended to have its own public
-entry point. Theme implementations are reviewed in separate pull requests.
+Ready-to-use themes for [Bref-ui](https://github.com/feuersteiner/bref-ui), built
+with Svelte 5, native HTML and scoped CSS. Pick a visual style and compose familiar
+Bref components through a dedicated theme entry point.
 
-The Todo, House Shop and RunnerAI demos use canonical Bref components and palette
-configuration. Their sources and previews live in [docs](../docs/README.md).
+[![npm](https://img.shields.io/npm/v/bref-ui-themes?logo=npm)](https://www.npmjs.com/package/bref-ui-themes)
+[![Discord](https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white)](https://discord.gg/JpgQRTUsVS)
+[![MIT license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/feuersteiner/bref-ui/blob/main/LICENSE)
+
+Explore the [theme galleries](https://feuersteiner.github.io/bref-ui/themes) for
+component examples and interaction states, or browse the
+[Bref-ui documentation](https://feuersteiner.github.io/bref-ui/).
 
 https://github.com/user-attachments/assets/3326a5c3-0573-4b40-bb8e-9a10da1fd6ac
 
-See New Paris, VS Code and Glassy in action. The [video app and storyboard](../video-demo/README.md)
+See New Paris, VS Code and Glassy in action. The
+[video app and storyboard](https://github.com/feuersteiner/bref-ui/tree/main/video-demo)
 are part of this repository.
 
+## Available themes
+
+| Theme                                                                      | Style                                           | Import                        |
+| -------------------------------------------------------------------------- | ----------------------------------------------- | ----------------------------- |
+| [New Paris](https://feuersteiner.github.io/bref-ui/themes/new-paris)       | Black and ivory, serif headings, paper overlays | `bref-ui-themes/new-paris`    |
+| [Glassy](https://feuersteiner.github.io/bref-ui/themes/glassy)             | Translucent controls and frosted overlays       | `bref-ui-themes/glassy`       |
+| [Crystal Code](https://feuersteiner.github.io/bref-ui/themes/crystal-code) | Light and dark frosted workbench                | `bref-ui-themes/crystal-code` |
+| [VS Code](https://feuersteiner.github.io/bref-ui/themes/vscode)            | Fixed-dark workbench                            | `bref-ui-themes/vscode`       |
+
+Each entry point exports twenty components, including `Theme`, `Button`, form
+controls, overlays and navigation. Importing one theme does not load the others.
+
 ## Installation
 
 Install [bref-ui-themes from npm](https://www.npmjs.com/package/bref-ui-themes) in a Svelte 5 app:
@@ -132,3 +151,17 @@ Material Symbols icons load automatically with Theme. Text uses system fonts, so
 no custom text font installation is required.
 
 The gallery uses the same public package exports at `/themes/vscode`.
+
+## Community and contributing
+
+Join [Discord](https://discord.gg/JpgQRTUsVS) and use the `bref-ui` channel for
+questions and examples. Report bugs and suggest themes through
+[GitHub Issues](https://github.com/feuersteiner/bref-ui/issues).
+
+This package lives in the [Bref-ui monorepo](https://github.com/feuersteiner/bref-ui/tree/main/themes).
+See [CONTRIBUTING.md](https://github.com/feuersteiner/bref-ui/blob/main/CONTRIBUTING.md)
+for contribution guidelines.
+
+## License
+
+[MIT](https://github.com/feuersteiner/bref-ui/blob/main/LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "bref-ui-themes",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"scripts": {
 		"dev": "vite dev",
 		"build": "vite build && npm run prepack",