pankosmia-bcv-muncher 0.2.1 → 0.2.2

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.
package/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # pankosmia-bcv-muncher
2
+
3
+ `pankosmia-bcv-muncher` provides reusable BCV-flavored muncher components for the Pankosmia ecosystem.
4
+
5
+ This package contains a set of focused UI tools that can be integrated into Pankosmia clients when BCV (Book/Chapter/Verse) editing or visualization capabilities are needed.
6
+
7
+ > **Note:** This package does not contain everything available inside `pankosmia/core-contenthandler_bcv`. It only exposes reusable components that may or may not be used by other Pankosmia clients.
8
+
9
+ ## Components
10
+
11
+ ### `BcvNotesEditorMuncher`
12
+
13
+ A component that allows users to edit BCV content.
14
+
15
+ It provides the editing interface required to create and modify both notes and questions.
16
+
17
+ ---
18
+
19
+ ### `BcvNotesViewerMuncher`
20
+
21
+ A component that allows users to view BCV notes.
22
+
23
+ It is intended for read-only visualization use cases where editing capabilities are not required.
24
+
25
+ ---
26
+
27
+ ### `BcvQuestionsViewerMuncher`
28
+
29
+ A component that allows users to view BCV questions.
30
+
31
+ It is intended for read-only visualization use cases where editing capabilities are not required.
32
+
33
+ ---
34
+
35
+ ## Scope
36
+
37
+ This package contains only reusable BCV-related components.
38
+
39
+ Included:
40
+
41
+ - BCV editing components (notes and questions)
42
+ - BCV notes viewing components
43
+ - BCV questions viewing components
44
+
45
+ Not included:
46
+
47
+ - The complete `pankosmia/core-contenthandler_bcv` application
48
+ - Application-specific features
49
+ - Internal tools that are not intended for reuse
50
+
51
+ The goal of this package is to provide lightweight, reusable building blocks for BCV features across the Pankosmia ecosystem.
52
+
53
+ ## Testing
54
+
55
+ To test the Muncher components locally:
56
+
57
+ 1. Start the development server:
58
+
59
+ ```bash
60
+ pnpm run dev
61
+ ```
62
+
63
+ 2. Navigate to:
64
+ `/#/MuncherTest`
65
+
66
+ ## Publishing
67
+
68
+ To publish this package to npm, use the following command:
69
+
70
+ ```bash
71
+ pnpm run publish
72
+ ```
@@ -32366,4 +32366,4 @@ export {
32366
32366
  nN as BcvNotesViewerMuncher,
32367
32367
  aN as BcvQuestionsViewerMuncher
32368
32368
  };
32369
- //# sourceMappingURL=bcv_muncher-rcl.es.js.map
32369
+ //# sourceMappingURL=bcv-muncher-rcl.es.js.map