@wishbone-media/spark 0.31.0 → 0.32.0

package/README.md

@@ -1,28 +1,14 @@
 # Spark UI Package
 
-## Dev notes
+## Project Overview
 
-### Common use aliases
+Spark is a Vue 3 UI component library published as `@wishbone-media/spark`. It provides reusable components, composables, stores, and utilities for building authenticated multi-tenant web applications. The library is distributed via npm and designed to be consumed by other Wishbone applications.
 
-#### Switch to local file package of Spark for Tabula or other clone of Tabula, use for testing and dev purpose of Spark
-```
-alias spark.relink='pnpm add link:../spark && rm -rf node_modules && pnpm i'
-```
+## Related Projects 
 
-#### Switch to actual public package of Spark for Tabula or other clone of Tabula, use before commit and push
-```
-alias spark.public='pnpm remove @wishbone-media/spark && pnpm i @wishbone-media/spark && rm -rf node_modules && pnpm i'
-```
+- [Tabula](../tabula) - Demo/storybook app showcasing Spark components. Also serves as the boilerplate template for new admin apps.
+- [BOLT Web Next](../bolt-web-next) - Production admin interface using Spark. Reference implementation for real-world patterns.
 
-### General development process
+## Documentation
 
-#### In Tabula folder
-```
-spark.relink # Set tabula to use symblinked local spark at (../spark) for @wishbone-media/spark
-pnpm dev # Serves the tabula in browser
-```
-
-#### In Spark folder
-```
-pnpm build --watch # Build spark on change
-```
+- Many existing features have been documented in [docs](./docs) as markdown files