packlyze 1.0.0 → 1.0.1

package/README.md

@@ -1,5 +1,11 @@
 # Packlyze
 
+[![NPM Version](https://img.shields.io/npm/v/packlyze.svg)](https://www.npmjs.com/package/packlyze)
+[![Build Status](https://img.shields.io/github/workflow/status/iamabhshk/Packlyze/CI)](https://github.com/iamabhshk/Packlyze/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Packlyze
+
 Advanced bundle analyzer with insights, recommendations, and historical tracking.
 
 ## 📊 Features
@@ -14,6 +20,8 @@ Advanced bundle analyzer with insights, recommendations, and historical tracking
 
 ## 🚀 Installation
 
+You can install Packlyze globally or use it via npx:
+
 ```bash
 npm install -g packlyze               
 # or
@@ -22,8 +30,12 @@ npx packlyze
 
 ## 📖 Usage
 
+Packlyze works with stats files generated by webpack, rollup, or esbuild. For best results, generate a stats file in JSON format.
+
 ### Basic Analysis
 
+Generate a stats file with your bundler, then analyze it:
+
 ```bash
 # Generate webpack stats
 webpack --profile --json > stats.json
@@ -37,12 +49,16 @@ packlyze analyze stats.json -o ./reports/bundle-report.html
 
 ### JSON Output
 
+Get results in JSON format for CI/CD or further processing:
+
 ```bash
 packlyze analyze stats.json --json
 ```
 
 ### As a Library
 
+You can use Packlyze programmatically in your Node.js/TypeScript projects:
+
 ```typescript
 import { Packlyze } from 'packlyze';
 
@@ -56,6 +72,8 @@ console.log(result.bundleStats.modules);
 
 ## 📁 Project Structure
 
+Typical structure for a Packlyze-based project:
+
 ```
 Packlyze-plus/
 ├── src/
@@ -77,37 +95,11 @@ Packlyze-plus/
 └── README.md
 ```
 
-## 🔧 Development
-
-### Setup
-
-```bash
-npm install
-npm run dev    # Watch mode TypeScript compilation
-```
-
-### Build
-
-```bash
-npm run build  # Compile TypeScript to JavaScript
-```
-
-### Testing
-
-```bash
-npm run test           # Run all tests
-npm run test:coverage  # Generate coverage report
-```
-
-### Code Quality
-
-```bash
-npm run lint      # ESLint check and fix
-npm run format    # Prettier formatting
-```
 
 ## 📊 Analysis Output
 
+Packlyze provides detailed metrics, recommendations, and insights to help you optimize your bundle.
+
 The analyzer provides:
 
 ### Metrics
@@ -130,6 +122,8 @@ The analyzer provides:
 
 ## 🎯 Use Cases
 
+Common scenarios where Packlyze is helpful:
+
 - **Performance Optimization**: Identify and reduce bundle bloat
 - **Code Splitting**: Find optimal splitting points
 - **Dependency Analysis**: Detect unused or duplicate packages
@@ -138,6 +132,8 @@ The analyzer provides:
 
 ## 📝 Examples
 
+Here are some example commands and configurations for different frameworks:
+
 ### Webpack Project
 
 ```bash
@@ -176,6 +172,8 @@ packlyze analyze dist/stats.json
 
 ## 🐛 Troubleshooting
 
+If you encounter issues, check the following:
+
 ### "Stats file not found"
 Ensure your stats.json path is correct and the file exists.
 
@@ -189,12 +187,25 @@ Consider:
 - Removing unused dependencies
 - Using lighter alternatives
 
+## 📦 Publishing to NPM
+
+To publish your own version of Packlyze:
+1. Update the version in `package.json`.
+2. Run `npm run build` to compile TypeScript.
+3. Run tests with `npm run test`.
+4. Login to NPM: `npm login`.
+5. Publish: `npm publish`.
+
+---
+
 ## 📄 License
 
 MIT
 
 ## 🤝 Contributing
 
+We welcome contributions! Please follow the steps below:
+
 Contributions welcome! Please:
 
 1. Fork the repository
@@ -205,6 +216,11 @@ Contributions welcome! Please:
 
 ## 📞 Support
 
+For issues and questions:
+- GitHub Issues: [https://github.com/iamabhshk/Packlyze/issues](https://github.com/iamabhshk/Packlyze/issues)
+- Email: [your-email]
+- Twitter: [@yourhandle]
+
 For issues and questions:
 - GitHub Issues: [link]
 - Email: [your-email]
@@ -212,8 +228,10 @@ For issues and questions:
 
 ## 🙏 Acknowledgments
 
+Packlyze is built with TypeScript, Commander.js, and Chalk. Special thanks to all contributors and users!
+
 Built with TypeScript, Commander.js, and Chalk
 
 ---
 
-**Made with ❤️ by [Your Name]**
+**Made with ❤️ by Abhishek**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "packlyze",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Advanced bundle analyzer with insights, recommendations, and historical tracking",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",