mani-calc 1.2.2 → 2.1.1

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/OVERLAY_MODE.md DELETED
@@ -1,364 +0,0 @@
1
- # 🎨 Overlay Mode - Floating Search Box
2
-
3
- ## ✨ New Feature: Spotlight-Style Overlay
4
-
5
- Mani-Calc now includes a **beautiful floating search box** that appears anywhere on your screen with a simple keyboard shortcut!
6
-
7
- ---
8
-
9
- ## 🚀 Quick Start
10
-
11
- ### 1. Install Dependencies
12
- ```bash
13
- npm install
14
- ```
15
-
16
- ### 2. Start Overlay Mode
17
- ```bash
18
- npm run overlay
19
- ```
20
-
21
- Or after global installation:
22
- ```bash
23
- mani-calc-overlay
24
- ```
25
-
26
- ### 3. Use the Hotkey
27
- Press **`Alt+Space`** anywhere in Windows to toggle the search box!
28
-
29
- ---
30
-
31
- ## 🎯 Features
32
-
33
- ### ⚡ Global Hotkey
34
- - **Default**: `Alt+Space`
35
- - Works from any application
36
- - Instant access to calculations
37
- - Always-on-top overlay
38
-
39
- ### 🧮 All Calculation Features
40
- - Math expressions
41
- - Natural language queries
42
- - Unit conversions
43
- - Calculation history
44
-
45
- ### 💻 System Commands
46
- Control your computer with simple commands:
47
-
48
- | Command | Action |
49
- |---------|--------|
50
- | `help` | Show available commands |
51
- | `theme` | Toggle Light/Dark mode |
52
- | `quit` | Quit application |
53
- | `sleep` | Put computer to sleep |
54
- | `shutdown` | Shutdown computer |
55
- | `restart` | Restart computer |
56
- | `lock` | Lock computer |
57
- | `logout` | Log out current user |
58
- | `empty recycle bin` | Empty recycle bin |
59
- | `volume up` | Increase volume |
60
- | `volume down` | Decrease volume |
61
- | `mute` | Mute volume |
62
- | `unmute` | Unmute volume |
63
-
64
- ### 🎨 Beautiful UI
65
- - Glassmorphism design
66
- - Smooth animations
67
- - Live preview
68
- - Auto-hide on blur
69
- - Keyboard shortcuts
70
-
71
- ---
72
-
73
- ## 📖 Usage
74
-
75
- ### Basic Calculations
76
- ```
77
- Type: 2 + 3 * 5
78
- Result: ✓ 2 + 3 * 5 = 17
79
- ```
80
-
81
- ### Natural Language
82
- ```
83
- Type: what is 25% of 200
84
- Result: ✓ what is 25% of 200 = 50
85
- ```
86
-
87
- ### Unit Conversions
88
- ```
89
- Type: 10 km to miles
90
- Result: ✓ 10 km = 6.21 miles
91
- ```
92
-
93
- ### System Commands
94
- ```
95
- Type: sleep
96
- Result: ✓ System going to sleep...
97
- ```
98
-
99
- ```
100
- Type: lock
101
- Result: ✓ Locking computer...
102
- ```
103
-
104
- ---
105
-
106
- ## ⌨️ Keyboard Shortcuts
107
-
108
- | Shortcut | Action |
109
- |----------|--------|
110
- | `Alt+Space` | Toggle search box |
111
- | `Enter` | Execute query |
112
- | `Esc` | Close search box |
113
- | `Ctrl+C` | Exit overlay mode |
114
-
115
- ---
116
-
117
- ## 🎨 UI Features
118
-
119
- ### Glassmorphism Design
120
- - Semi-transparent white background
121
- - Blur effect
122
- - Smooth shadows
123
- - Modern aesthetic
124
-
125
- ### Live Preview
126
- - See results as you type
127
- - Instant feedback
128
- - No need to press Enter for simple calculations
129
-
130
- ### Auto-Hide
131
- - Automatically hides when you click outside
132
- - Keeps your desktop clean
133
- - Instant recall with hotkey
134
-
135
- ### Smooth Animations
136
- - Slide-down effect for results
137
- - Fade transitions
138
- - Professional feel
139
-
140
- ---
141
-
142
- ## 🔧 Advanced Configuration
143
-
144
- ### Change Hotkey
145
- Edit `src/ui/floating-search.js`:
146
-
147
- ```javascript
148
- this.hotkey = 'Ctrl+Shift+Space'; // Your custom hotkey
149
- ```
150
-
151
- ### Customize Position
152
- Edit `src/ui/floating-search.js`:
153
-
154
- ```javascript
155
- const y = Math.floor(height * 0.3); // Change 0.3 to adjust vertical position
156
- ```
157
-
158
- ### Customize Appearance
159
- Edit `src/ui/overlay.html` CSS section to change:
160
- - Colors
161
- - Size
162
- - Transparency
163
- - Border radius
164
- - Shadows
165
-
166
- ---
167
-
168
- ## 💡 Use Cases
169
-
170
- ### Quick Calculations While Working
171
- ```
172
- Working in Excel → Alt+Space → "2500 * 0.15" → Enter
173
- Result copied → Paste in Excel
174
- ```
175
-
176
- ### System Control
177
- ```
178
- Finishing work → Alt+Space → "lock" → Enter
179
- Computer locked instantly
180
- ```
181
-
182
- ### Unit Conversions
183
- ```
184
- Reading recipe → Alt+Space → "2 cups to ml" → Enter
185
- Result: 473.18 ml
186
- ```
187
-
188
- ### Quick Sleep
189
- ```
190
- Alt+Space → "sleep" → Enter
191
- Computer goes to sleep
192
- ```
193
-
194
- ---
195
-
196
- ## 🛠️ Troubleshooting
197
-
198
- ### Hotkey Not Working?
199
-
200
- **Check for conflicts:**
201
- ```bash
202
- # Other apps might be using Alt+Space
203
- # Change the hotkey in floating-search.js
204
- ```
205
-
206
- ### Overlay Not Appearing?
207
-
208
- **Restart overlay mode:**
209
- ```bash
210
- # Press Ctrl+C to stop
211
- # Run: npm run overlay
212
- ```
213
-
214
- ### System Commands Not Working?
215
-
216
- **Run as Administrator:**
217
- ```bash
218
- # Right-click Command Prompt → Run as Administrator
219
- # Then: npm run overlay
220
- ```
221
-
222
- ---
223
-
224
- ## 🎯 Comparison: Overlay vs Windows Search
225
-
226
- | Feature | Overlay Mode | Windows Search |
227
- |---------|--------------|----------------|
228
- | **Hotkey** | Alt+Space (customizable) | Win+S |
229
- | **Position** | Center screen | Top-right |
230
- | **Design** | Modern glassmorphism | Windows default |
231
- | **System Commands** | ✅ Yes | ❌ No |
232
- | **Live Preview** | ✅ Yes | ❌ No |
233
- | **Always Available** | ✅ Yes | ✅ Yes |
234
-
235
- **Use Both!**
236
- - **Overlay**: Quick calculations, system commands
237
- - **Windows Search**: File search, web search, calculations
238
-
239
- ---
240
-
241
- ## 🚀 Auto-Start on Windows Boot
242
-
243
- ### Option 1: Task Scheduler
244
- 1. Open Task Scheduler
245
- 2. Create Basic Task
246
- 3. Name: "Mani-Calc Overlay"
247
- 4. Trigger: At log on
248
- 5. Action: Start program
249
- 6. Program: `C:\Program Files\nodejs\node.exe`
250
- 7. Arguments: `C:\Users\[YourName]\AppData\Roaming\npm\node_modules\mani-calc\bin\overlay.js`
251
-
252
- ### Option 2: Startup Folder
253
- 1. Press `Win+R`
254
- 2. Type: `shell:startup`
255
- 3. Create shortcut to overlay.js
256
- 4. Restart computer
257
-
258
- ---
259
-
260
- ## 📊 Performance
261
-
262
- - **Memory Usage**: ~50-80 MB (Electron)
263
- - **CPU Usage**: <1% when idle
264
- - **Startup Time**: ~2 seconds
265
- - **Response Time**: <100ms
266
-
267
- ---
268
-
269
- ## 🎨 Customization Ideas
270
-
271
- ### Change Theme
272
- Edit `overlay.html` CSS:
273
- ```css
274
- /* Dark theme */
275
- .search-box {
276
- background: rgba(30, 30, 30, 0.95);
277
- color: white;
278
- }
279
- ```
280
-
281
- ### Add More System Commands
282
- Edit `floating-search.js`:
283
- ```javascript
284
- 'screenshot': {
285
- action: async () => {
286
- await execAsync('snippingtool');
287
- return 'Opening Snipping Tool...';
288
- }
289
- }
290
- ```
291
-
292
- ### Change Size
293
- Edit `floating-search.js`:
294
- ```javascript
295
- width: 800, // Make wider
296
- height: 100, // Make taller
297
- ```
298
-
299
- ---
300
-
301
- ## 🔐 Privacy & Security
302
-
303
- ### System Commands
304
- - All commands run locally
305
- - No network requests
306
- - Requires user confirmation (Enter key)
307
- - Can be disabled by removing commands
308
-
309
- ### Data Storage
310
- - Same as CLI mode
311
- - History stored locally
312
- - No telemetry
313
-
314
- ---
315
-
316
- ## 🎉 Tips & Tricks
317
-
318
- ### 1. Quick Math
319
- ```
320
- Alt+Space → "15*23" → Enter
321
- Result copied instantly
322
- ```
323
-
324
- ### 2. Chain Commands
325
- ```
326
- Alt+Space → "100 km to miles" → Enter
327
- Alt+Space → "lock" → Enter
328
- ```
329
-
330
- ### 3. Use as Calculator Replacement
331
- ```
332
- Never open Calculator app again!
333
- Alt+Space is faster
334
- ```
335
-
336
- ### 4. System Control Hub
337
- ```
338
- Alt+Space → "sleep"
339
- Alt+Space → "lock"
340
- Alt+Space → "mute"
341
- ```
342
-
343
- ---
344
-
345
- ## 🗺️ Future Enhancements
346
-
347
- - [ ] Custom themes
348
- - [ ] Plugin system
349
- - [ ] File search integration
350
- - [ ] Web search integration
351
- - [ ] Clipboard history
352
- - [ ] Snippets/templates
353
- - [ ] Multi-monitor support
354
- - [ ] Custom hotkeys per command
355
-
356
- ---
357
-
358
- ## 🤝 Contributing
359
-
360
- Want to add more system commands or features? See [CONTRIBUTING.md](../CONTRIBUTING.md)
361
-
362
- ---
363
-
364
- **Enjoy your new productivity superpower!** ⚡
@@ -1,291 +0,0 @@
1
- # 📦 Publishing Mani-Calc to NPM
2
-
3
- ## ✅ Pre-Publishing Checklist
4
-
5
- Before publishing, let's make sure everything is ready:
6
-
7
- - [x] Package name: `mani-calc` (unique and available)
8
- - [x] Version: `1.1.0`
9
- - [x] All files committed to Git
10
- - [x] README.md is comprehensive
11
- - [x] LICENSE file exists (MIT)
12
- - [x] package.json is properly configured
13
- - [x] Tests are passing
14
- - [x] Dependencies are installed
15
-
16
- ---
17
-
18
- ## 🚀 Step-by-Step Publishing Guide
19
-
20
- ### Step 1: Create NPM Account (if you don't have one)
21
-
22
- Visit: https://www.npmjs.com/signup
23
-
24
- Or use the command line:
25
- ```bash
26
- npm adduser
27
- ```
28
-
29
- ### Step 2: Login to NPM
30
-
31
- ```bash
32
- npm login
33
- ```
34
-
35
- You'll be prompted for:
36
- - **Username**: Your npm username
37
- - **Password**: Your npm password
38
- - **Email**: Your email (will be public)
39
- - **One-time password**: If you have 2FA enabled
40
-
41
- ### Step 3: Verify Login
42
-
43
- ```bash
44
- npm whoami
45
- ```
46
-
47
- This should display your npm username.
48
-
49
- ### Step 4: Test Package Locally (Optional but Recommended)
50
-
51
- ```bash
52
- # Create a tarball to see what will be published
53
- npm pack
54
-
55
- # This creates mani-calc-1.1.0.tgz
56
- # You can inspect it to see what files will be included
57
- ```
58
-
59
- ### Step 5: Publish to NPM
60
-
61
- ```bash
62
- npm publish
63
- ```
64
-
65
- **That's it!** 🎉
66
-
67
- ---
68
-
69
- ## 📋 What Gets Published
70
-
71
- Based on your `.gitignore` and `package.json`, these files will be published:
72
-
73
- ### ✅ Included
74
- - `bin/` - CLI scripts
75
- - `src/` - Source code
76
- - `test/` - Tests
77
- - `README.md` - Documentation
78
- - `LICENSE` - MIT License
79
- - `CHANGELOG.md` - Version history
80
- - `QUICKSTART.md` - Quick start guide
81
- - `EXAMPLES.md` - Usage examples
82
- - `ARCHITECTURE.md` - Technical docs
83
- - `CONTRIBUTING.md` - Contribution guide
84
- - `OVERLAY_MODE.md` - Overlay mode docs
85
- - `package.json` - Package config
86
-
87
- ### ❌ Excluded (via .gitignore)
88
- - `node_modules/` - Dependencies
89
- - `.vscode/` - Editor config
90
- - `*.log` - Log files
91
- - `.env` - Environment files
92
-
93
- ---
94
-
95
- ## 🎯 After Publishing
96
-
97
- ### 1. Verify Publication
98
-
99
- Visit: https://www.npmjs.com/package/mani-calc
100
-
101
- You should see your package!
102
-
103
- ### 2. Test Installation
104
-
105
- ```bash
106
- # In a different directory
107
- npm install -g mani-calc
108
-
109
- # Test it
110
- mani-calc "2 + 3 * 5"
111
- ```
112
-
113
- ### 3. Create GitHub Release
114
-
115
- 1. Go to: https://github.com/Maniredii/mani-calc/releases
116
- 2. Click "Create a new release"
117
- 3. Tag: `v1.1.0`
118
- 4. Title: `v1.1.0 - Overlay Mode Release`
119
- 5. Description: Copy from `RELEASE_NOTES_v1.1.0.md`
120
- 6. Publish release
121
-
122
- ### 4. Update README Badge
123
-
124
- Your npm version badge will now work:
125
- ```markdown
126
- [![npm version](https://img.shields.io/npm/v/mani-calc.svg)](https://www.npmjs.com/package/mani-calc)
127
- ```
128
-
129
- ---
130
-
131
- ## 🔄 Updating the Package (Future)
132
-
133
- When you want to publish updates:
134
-
135
- ### 1. Update Version
136
-
137
- ```bash
138
- # For bug fixes (1.1.0 → 1.1.1)
139
- npm version patch
140
-
141
- # For new features (1.1.0 → 1.2.0)
142
- npm version minor
143
-
144
- # For breaking changes (1.1.0 → 2.0.0)
145
- npm version major
146
- ```
147
-
148
- This automatically:
149
- - Updates `package.json`
150
- - Creates a git commit
151
- - Creates a git tag
152
-
153
- ### 2. Push Changes
154
-
155
- ```bash
156
- git push origin main --tags
157
- ```
158
-
159
- ### 3. Publish
160
-
161
- ```bash
162
- npm publish
163
- ```
164
-
165
- ---
166
-
167
- ## 🛠️ Troubleshooting
168
-
169
- ### Error: "Package name already exists"
170
-
171
- If `mani-calc` is taken, you'll need to:
172
- 1. Choose a different name (e.g., `@yourusername/mani-calc`)
173
- 2. Update `package.json` name field
174
- 3. Try publishing again
175
-
176
- ### Error: "You must be logged in"
177
-
178
- ```bash
179
- npm login
180
- ```
181
-
182
- ### Error: "You do not have permission"
183
-
184
- Make sure you're logged in as the correct user:
185
- ```bash
186
- npm whoami
187
- ```
188
-
189
- ### Error: "Version already published"
190
-
191
- You can't republish the same version. Bump the version:
192
- ```bash
193
- npm version patch
194
- npm publish
195
- ```
196
-
197
- ---
198
-
199
- ## 📊 NPM Package Stats
200
-
201
- After publishing, you can track:
202
-
203
- - **Downloads**: https://npm-stat.com/charts.html?package=mani-calc
204
- - **Package page**: https://www.npmjs.com/package/mani-calc
205
- - **Unpkg CDN**: https://unpkg.com/mani-calc/
206
-
207
- ---
208
-
209
- ## 🎯 Marketing After Publishing
210
-
211
- ### 1. Share on Social Media
212
-
213
- **Twitter/X:**
214
- ```
215
- 🎉 Just published mani-calc v1.1.0 to npm!
216
-
217
- ⚡ Spotlight-style calculator for Windows
218
- 🎨 NEW: Floating search box (Alt+Space)
219
- 💻 System commands (sleep, lock, etc.)
220
- 🔄 Unit conversions & natural language
221
-
222
- npm install -g mani-calc
223
-
224
- https://www.npmjs.com/package/mani-calc
225
- https://github.com/Maniredii/mani-calc
226
- ```
227
-
228
- ### 2. Post on Reddit
229
-
230
- Subreddits:
231
- - r/node
232
- - r/javascript
233
- - r/Windows
234
- - r/productivity
235
- - r/programming
236
-
237
- ### 3. Submit to Product Hunt
238
-
239
- https://www.producthunt.com/posts/create
240
-
241
- ### 4. Write a Blog Post
242
-
243
- Platforms:
244
- - Dev.to
245
- - Hashnode
246
- - Medium
247
-
248
- ### 5. Create a Demo Video
249
-
250
- Record yourself using:
251
- - Windows Search integration
252
- - Overlay mode
253
- - System commands
254
-
255
- Upload to YouTube and link in README.
256
-
257
- ---
258
-
259
- ## 📈 Success Metrics
260
-
261
- Track these after publishing:
262
-
263
- - **Week 1 Goal**: 100 downloads
264
- - **Month 1 Goal**: 500 downloads
265
- - **GitHub Stars**: 50+
266
- - **Issues/PRs**: Community engagement
267
-
268
- ---
269
-
270
- ## 🎉 Ready to Publish!
271
-
272
- Your package is production-ready. Just run:
273
-
274
- ```bash
275
- npm login
276
- npm publish
277
- ```
278
-
279
- And you're live! 🚀
280
-
281
- ---
282
-
283
- ## 📞 Need Help?
284
-
285
- - NPM Docs: https://docs.npmjs.com/
286
- - Publishing Guide: https://docs.npmjs.com/cli/v8/commands/npm-publish
287
- - Package Naming: https://docs.npmjs.com/cli/v8/configuring-npm/package-json#name
288
-
289
- ---
290
-
291
- **Good luck with your launch!** 🎊