@muibook/components 1.0.8 → 1.0.10

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/package.json +1 -2
  2. package/readme.md +25 -1
  3. package/readme.npm.md +0 -18
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@muibook/components",
3
- "version": "1.0.8",
3
+ "version": "1.0.10",
4
4
  "description": "A library of MUI-based design system components.",
5
5
  "author": "Michael Trilford",
6
6
  "homepage": "https://muibook.com",
@@ -14,7 +14,6 @@
14
14
  "main": "./dist/esm/index.js",
15
15
  "module": "./dist/esm/index.js",
16
16
  "types": "./dist/types/index.d.ts",
17
- "readme": "readme.npm.md",
18
17
  "exports": {
19
18
  "./utils/part-map": {
20
19
  "import": "./dist/esm/utils/part-map/index.js",
package/readme.md CHANGED
@@ -1,6 +1,30 @@
1
1
  # Muibook
2
2
 
3
- This project is powered by [Vite](https://vitejs.dev/) and uses TypeScript to provide a fast, modern development experience for building and previewing web components.
3
+ ## Muibook/Components (NPM)
4
+
5
+ A library of reusable vanilla Web Components designed with the MichaelUI design language. Perfect for building consistent, framework-agnostic design systems inspired by MichaelUI’s principles.
6
+
7
+ - 📦 View on [npmjs.com](https://www.npmjs.com/package/@muibook/components?activeTab=readme)
8
+ - 🔌 Framework-agnostic: works in any modern JavaScript environment
9
+ - 🎨 Styled and structured according to MichaelUI guidelines
10
+ - ✨ Lightweight, fast, and customisable
11
+ - 🧱 Built for scalable and maintainable design systems
12
+
13
+ ---
14
+
15
+ ## Create Mui App
16
+
17
+ - Kickstart your project with a lightweight scaffold built on Vite. It comes preloaded with foundational CSS resets, a solid base structure, and design tokens ready to be customised for your brand.
18
+ - Access a curated set of MUI Components, wrapped in a clean layout that highlights the Design System’s core building blocks—so you can start designing and building immediately.
19
+ - Learn more at [Muibook.com](https://muibook.com/#/create-mui-app)
20
+
21
+ ---
22
+
23
+ ## Muibook Documentation
24
+
25
+ - Muibook is the home of the Mui Design System (MichaelUI) — native Web Components with clean, composable patterns that help you write less code
26
+ - Learn more about [Muibook.com](https://muibook.com)
27
+ - This project is powered by [Vite](https://vitejs.dev/) and uses TypeScript to provide a fast, modern development experience for building and previewing web components.
4
28
 
5
29
  ---
6
30
 
package/readme.npm.md DELETED
@@ -1,18 +0,0 @@
1
- # Muibook/Components
2
-
3
- A library of MUI-based design system components.
4
-
5
- ## Muibook Documentation
6
-
7
- - Muibook is the home of the Mui Design System (MichaelUI) — native Web Components with clean, composable patterns that help you write less code
8
- - Learn more about [Muibook.com](https://muibook.com)
9
-
10
- ## Create Mui App
11
-
12
- - Used within [Create Mui App](https://github.com/michaeltrilford/create-mui-app)
13
-
14
- ## Muibook Github
15
-
16
- - [Github](https://github.com/michaeltrilford/muibook)
17
-
18
- ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)