@musetax/compass-widget 0.2.218 → 0.2.219

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 (2) hide show
  1. package/README.md +53 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1 +1,53 @@
1
- # Widget-Package
1
+ # 📦 Financial Widget Package
2
+
3
+ This package provides **two powerful embeddable widgets** to integrate into your application:
4
+
5
+ 1. 🔍 **Transaction Review Widget**
6
+ 2. 💸 **Deduction Discovery Widget**
7
+
8
+ Each widget includes a core JS embed option and a reusable ReactJS component.
9
+
10
+ ---
11
+
12
+ ## 🔧 Features Overview
13
+
14
+ ### 1. 🔍 Transaction Review Widget
15
+
16
+ Helps users review and categorize transactions effectively.
17
+
18
+ **Key Features**:
19
+ - Embeddable JavaScript snippet
20
+ - Session-token-based secure API integration
21
+ - Category update popup
22
+ - Internal UI interaction (open/close)
23
+ - React component version with validation and customization support
24
+
25
+ **Preview**:
26
+
27
+ ![Transaction Review Widget](https://res.cloudinary.com/dxxdvbzla/image/upload/v1750162428/1._Transaction_Review_Widget_hajyzn.png)
28
+ ![Update Category Widget](https://res.cloudinary.com/dxxdvbzla/image/upload/v1750162428/1._Transaction_Review_Widget-1_dr8zk6.png)
29
+
30
+ ---
31
+
32
+ ### 2. 💸 Deduction Discovery Widget
33
+
34
+ Helps users find potential tax deductions from their spending and transaction categories.
35
+
36
+ **Key Features**:
37
+ - Embedded widget or React component
38
+ - Secure session-token-based data loading
39
+ - Displays deduction cards with suggestions
40
+ - Supports tags and category filtering
41
+
42
+ **Preview**:
43
+
44
+ ![Deduction Discovery Widget](https://res.cloudinary.com/dxxdvbzla/image/upload/v1750161282/3._Deduction_Discovery_Widget_oswkaa.png)
45
+
46
+ ---
47
+
48
+ ## 📦 Installation
49
+
50
+ ### Option 1: React Package (Recommended for React Apps)
51
+
52
+ ```bash
53
+ npm install @musetax/compass-widget
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@musetax/compass-widget",
3
- "version": "0.2.218",
3
+ "version": "0.2.219",
4
4
  "dependencies": {
5
5
  "@testing-library/dom": "^10.4.0",
6
6
  "@testing-library/jest-dom": "^6.6.3",