boss-pagebuilder 0.0.1

package/README.md

@@ -0,0 +1,75 @@
+# Boss Page Builder
+
+A Vue 3 Page Builder library with Bootstrap 5 support.
+
+## Installation
+
+Install the package in your Vue project:
+
+```bash
+# Using npm with a local tarball (for testing)
+npm install ./path/to/boss-pagebuilder-0.0.1.tgz
+
+# Or if published to a registry
+npm install boss-pagebuilder
+```
+
+## Setup
+
+In your `main.ts` or `main.js`:
+
+```typescript
+import { createApp } from 'vue'
+import App from './App.vue'
+import BossPageBuilder from 'boss-pagebuilder'
+import 'boss-pagebuilder/style.css' // Import styles
+
+const app = createApp(App)
+
+app.use(BossPageBuilder) // Registers all components globally
+
+app.mount('#app')
+```
+
+## Usage
+
+### Full Page Builder
+
+To use the full page builder interface (Layout, Sidebar, Canvas, Properties):
+
+```vue
+<template>
+  <div class="page-builder-wrapper">
+    <BossPageBuilder />
+  </div>
+</template>
+
+<style>
+.page-builder-wrapper {
+  height: 100vh; /* Ensure container has height */
+  width: 100%;
+}
+</style>
+```
+
+### Individual Components
+
+You can also use individual components like the Rich Text Editor:
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import { Editor } from 'boss-pagebuilder'
+
+const content = ref('<p>Hello World</p>')
+</script>
+
+<template>
+  <Editor v-model="content" :chars-per-sms="160" />
+</template>
+```
+
+## Requirements
+
+- **Vue**: ^3.3.0
+- **Bootstrap**: ^5.3.0 (Styles are included)