mani-calc 1.1.0

package/PUBLISHING_GUIDE.md

@@ -0,0 +1,291 @@
+# 📦 Publishing Mani-Calc to NPM
+
+## ✅ Pre-Publishing Checklist
+
+Before publishing, let's make sure everything is ready:
+
+- [x] Package name: `mani-calc` (unique and available)
+- [x] Version: `1.1.0`
+- [x] All files committed to Git
+- [x] README.md is comprehensive
+- [x] LICENSE file exists (MIT)
+- [x] package.json is properly configured
+- [x] Tests are passing
+- [x] Dependencies are installed
+
+---
+
+## 🚀 Step-by-Step Publishing Guide
+
+### Step 1: Create NPM Account (if you don't have one)
+
+Visit: https://www.npmjs.com/signup
+
+Or use the command line:
+```bash
+npm adduser
+```
+
+### Step 2: Login to NPM
+
+```bash
+npm login
+```
+
+You'll be prompted for:
+- **Username**: Your npm username
+- **Password**: Your npm password
+- **Email**: Your email (will be public)
+- **One-time password**: If you have 2FA enabled
+
+### Step 3: Verify Login
+
+```bash
+npm whoami
+```
+
+This should display your npm username.
+
+### Step 4: Test Package Locally (Optional but Recommended)
+
+```bash
+# Create a tarball to see what will be published
+npm pack
+
+# This creates mani-calc-1.1.0.tgz
+# You can inspect it to see what files will be included
+```
+
+### Step 5: Publish to NPM
+
+```bash
+npm publish
+```
+
+**That's it!** 🎉
+
+---
+
+## 📋 What Gets Published
+
+Based on your `.gitignore` and `package.json`, these files will be published:
+
+### ✅ Included
+- `bin/` - CLI scripts
+- `src/` - Source code
+- `test/` - Tests
+- `README.md` - Documentation
+- `LICENSE` - MIT License
+- `CHANGELOG.md` - Version history
+- `QUICKSTART.md` - Quick start guide
+- `EXAMPLES.md` - Usage examples
+- `ARCHITECTURE.md` - Technical docs
+- `CONTRIBUTING.md` - Contribution guide
+- `OVERLAY_MODE.md` - Overlay mode docs
+- `package.json` - Package config
+
+### ❌ Excluded (via .gitignore)
+- `node_modules/` - Dependencies
+- `.vscode/` - Editor config
+- `*.log` - Log files
+- `.env` - Environment files
+
+---
+
+## 🎯 After Publishing
+
+### 1. Verify Publication
+
+Visit: https://www.npmjs.com/package/mani-calc
+
+You should see your package!
+
+### 2. Test Installation
+
+```bash
+# In a different directory
+npm install -g mani-calc
+
+# Test it
+mani-calc "2 + 3 * 5"
+```
+
+### 3. Create GitHub Release
+
+1. Go to: https://github.com/Maniredii/mani-calc/releases
+2. Click "Create a new release"
+3. Tag: `v1.1.0`
+4. Title: `v1.1.0 - Overlay Mode Release`
+5. Description: Copy from `RELEASE_NOTES_v1.1.0.md`
+6. Publish release
+
+### 4. Update README Badge
+
+Your npm version badge will now work:
+```markdown
+[![npm version](https://img.shields.io/npm/v/mani-calc.svg)](https://www.npmjs.com/package/mani-calc)
+```
+
+---
+
+## 🔄 Updating the Package (Future)
+
+When you want to publish updates:
+
+### 1. Update Version
+
+```bash
+# For bug fixes (1.1.0 → 1.1.1)
+npm version patch
+
+# For new features (1.1.0 → 1.2.0)
+npm version minor
+
+# For breaking changes (1.1.0 → 2.0.0)
+npm version major
+```
+
+This automatically:
+- Updates `package.json`
+- Creates a git commit
+- Creates a git tag
+
+### 2. Push Changes
+
+```bash
+git push origin main --tags
+```
+
+### 3. Publish
+
+```bash
+npm publish
+```
+
+---
+
+## 🛠️ Troubleshooting
+
+### Error: "Package name already exists"
+
+If `mani-calc` is taken, you'll need to:
+1. Choose a different name (e.g., `@yourusername/mani-calc`)
+2. Update `package.json` name field
+3. Try publishing again
+
+### Error: "You must be logged in"
+
+```bash
+npm login
+```
+
+### Error: "You do not have permission"
+
+Make sure you're logged in as the correct user:
+```bash
+npm whoami
+```
+
+### Error: "Version already published"
+
+You can't republish the same version. Bump the version:
+```bash
+npm version patch
+npm publish
+```
+
+---
+
+## 📊 NPM Package Stats
+
+After publishing, you can track:
+
+- **Downloads**: https://npm-stat.com/charts.html?package=mani-calc
+- **Package page**: https://www.npmjs.com/package/mani-calc
+- **Unpkg CDN**: https://unpkg.com/mani-calc/
+
+---
+
+## 🎯 Marketing After Publishing
+
+### 1. Share on Social Media
+
+**Twitter/X:**
+```
+🎉 Just published mani-calc v1.1.0 to npm!
+
+⚡ Spotlight-style calculator for Windows
+🎨 NEW: Floating search box (Alt+Space)
+💻 System commands (sleep, lock, etc.)
+🔄 Unit conversions & natural language
+
+npm install -g mani-calc
+
+https://www.npmjs.com/package/mani-calc
+https://github.com/Maniredii/mani-calc
+```
+
+### 2. Post on Reddit
+
+Subreddits:
+- r/node
+- r/javascript
+- r/Windows
+- r/productivity
+- r/programming
+
+### 3. Submit to Product Hunt
+
+https://www.producthunt.com/posts/create
+
+### 4. Write a Blog Post
+
+Platforms:
+- Dev.to
+- Hashnode
+- Medium
+
+### 5. Create a Demo Video
+
+Record yourself using:
+- Windows Search integration
+- Overlay mode
+- System commands
+
+Upload to YouTube and link in README.
+
+---
+
+## 📈 Success Metrics
+
+Track these after publishing:
+
+- **Week 1 Goal**: 100 downloads
+- **Month 1 Goal**: 500 downloads
+- **GitHub Stars**: 50+
+- **Issues/PRs**: Community engagement
+
+---
+
+## 🎉 Ready to Publish!
+
+Your package is production-ready. Just run:
+
+```bash
+npm login
+npm publish
+```
+
+And you're live! 🚀
+
+---
+
+## 📞 Need Help?
+
+- NPM Docs: https://docs.npmjs.com/
+- Publishing Guide: https://docs.npmjs.com/cli/v8/commands/npm-publish
+- Package Naming: https://docs.npmjs.com/cli/v8/configuring-npm/package-json#name
+
+---
+
+**Good luck with your launch!** 🎊

package/QUICKSTART.md

@@ -0,0 +1,115 @@
+# 🚀 Quick Start Guide - Mani-Calc
+
+Get up and running with Mani-Calc in under 2 minutes!
+
+## Step 1: Install
+
+```bash
+npm install -g mani-calc
+```
+
+## Step 2: Set Up Windows Search Integration
+
+```bash
+mani-calc install
+```
+
+**Note:** You may need to run this as Administrator for full Windows Search integration.
+
+## Step 3: Start Using!
+
+### Option A: Windows Search (Recommended)
+1. Press `Win + S` to open Windows Search
+2. Type: `calc: 2 + 3 * 5`
+3. See instant result: **17**
+4. Result is automatically copied to clipboard!
+
+### Option B: Command Line
+```bash
+mani-calc "2 + 3 * 5"
+# Output: ✓ 2 + 3 * 5 = 17
+```
+
+### Option C: Interactive Mode
+```bash
+mani-calc
+# Then type your calculations:
+calc> 2 + 3 * 5
+✓ 2 + 3 * 5 = 17
+
+calc> 10 km to miles
+✓ 10 km = 6.21 miles
+
+calc> what is 25 percent of 200
+✓ what is 25 percent of 200 = 50
+```
+
+## Common Examples
+
+### Math
+```bash
+mani-calc "sqrt(144)"              # 12
+mani-calc "2^10"                   # 1024
+mani-calc "(100 - 20) / 4"         # 20
+```
+
+### Natural Language
+```bash
+mani-calc "what is 15 percent of 300"    # 45
+mani-calc "half of 120"                  # 60
+mani-calc "square root of 81"            # 9
+```
+
+### Unit Conversions
+```bash
+mani-calc "5 miles to km"                # 8.05 km
+mani-calc "10 kg to pounds"              # 22.05 pounds
+mani-calc "25 celsius to fahrenheit"     # 77 fahrenheit
+```
+
+### History
+```bash
+mani-calc history                  # View recent calculations
+mani-calc "clear history"          # Clear all history
+```
+
+## Tips & Tricks
+
+### 💡 Pro Tips
+- Results are **automatically copied** to your clipboard
+- Type `calc:` in Windows Search for instant access
+- Use `history` to review past calculations
+- All calculations work **100% offline**
+
+### 🎯 Keyboard Shortcuts
+- `Ctrl+C` in interactive mode to exit
+- Type `exit` or `quit` to leave interactive mode
+- Type `clear` to clear the screen
+- Type `help` for examples
+
+## Troubleshooting
+
+### Windows Search not working?
+```bash
+# Run as Administrator
+mani-calc install
+
+# Then restart Windows Explorer
+taskkill /f /im explorer.exe && start explorer.exe
+```
+
+### Need help?
+```bash
+mani-calc --help
+```
+
+## What's Next?
+
+- ⭐ Star the project on [GitHub](https://github.com/manireddy/mani-calc)
+- 📖 Read the full [README](README.md) for all features
+- 🐛 Report bugs or request features in [Issues](https://github.com/manireddy/mani-calc/issues)
+- 🤝 Contribute! See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+---
+
+**Happy calculating! 🧮**

package/QUICK_PUBLISH.md

@@ -0,0 +1,108 @@
+# 🚀 Quick Publishing Commands
+
+## Step 1: Login to NPM
+
+```bash
+npm login
+```
+
+**You'll be asked for:**
+- Username
+- Password  
+- Email
+- One-time password (if 2FA enabled)
+
+**Don't have an npm account?**
+Create one at: https://www.npmjs.com/signup
+
+---
+
+## Step 2: Verify Login
+
+```bash
+npm whoami
+```
+
+Should show your npm username.
+
+---
+
+## Step 3: Publish!
+
+```bash
+npm publish
+```
+
+**That's it!** Your package will be live at:
+https://www.npmjs.com/package/mani-calc
+
+---
+
+## 🎉 After Publishing
+
+### Test Installation
+```bash
+npm install -g mani-calc
+mani-calc "2 + 3 * 5"
+```
+
+### Share the News!
+```
+🎉 mani-calc v1.1.0 is now on npm!
+
+⚡ Spotlight for Windows
+🎨 Floating search box (Alt+Space)
+💻 System commands
+🔄 Unit conversions
+
+npm install -g mani-calc
+
+https://www.npmjs.com/package/mani-calc
+```
+
+---
+
+## 📊 Your Package Info
+
+- **Name**: `mani-calc`
+- **Version**: `1.1.0`
+- **Description**: Spotlight-style instant calculator for Windows Search
+- **License**: MIT
+- **Repository**: https://github.com/Maniredii/mani-calc
+
+---
+
+## ⚠️ Important Notes
+
+1. **Package name must be unique** - `mani-calc` should be available
+2. **Can't unpublish** - After 24 hours, you can only deprecate
+3. **Version must be unique** - Can't republish same version
+4. **Email will be public** - Your npm email is visible
+
+---
+
+## 🔄 Future Updates
+
+```bash
+# Update version
+npm version patch  # 1.1.0 → 1.1.1
+npm version minor  # 1.1.0 → 1.2.0
+npm version major  # 1.1.0 → 2.0.0
+
+# Push to GitHub
+git push origin main --tags
+
+# Publish
+npm publish
+```
+
+---
+
+**Ready? Run these commands:**
+
+```bash
+npm login
+npm publish
+```
+
+🚀 **Let's make mani-calc available to the world!**