packlyze 1.0.0 → 1.0.2

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,48 +20,72 @@ 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
 npx packlyze
 ```
 
-## 📖 Usage
-
-### Basic Analysis
-
-```bash
-# Generate webpack stats
-webpack --profile --json > stats.json
-
-# Analyze with packlyze
-packlyze analyze stats.json
-
-# Output HTML report to custom location
-packlyze analyze stats.json -o ./reports/bundle-report.html
-```
-
-### JSON Output
-
-```bash
-packlyze analyze stats.json --json
-```
-
-### As a Library
 
-```typescript
-import { Packlyze } from 'packlyze';
 
-const analyzer = new Packlyze('./dist/stats.json');
-const result = await analyzer.analyze();
-
-console.log(result.recommendations);
-console.log(result.metrics);
-console.log(result.bundleStats.modules);
-```
+## 📖 How to Use
+
+Packlyze can be used in two main ways: as a CLI tool and as a Node.js/TypeScript library.
+
+### 1. CLI Usage
+
+#### Step-by-step:
+1. **Install Packlyze** (globally or use npx):
+  ```bash
+  npm install -g packlyze
+  # or
+  npx packlyze --help
+  ```
+2. **Generate a stats file** from your bundler (e.g., webpack, rollup, esbuild):
+  ```bash
+  # For webpack:
+  webpack --profile --json > stats.json
+  ```
+3. **Run Packlyze analysis**:
+  ```bash
+  packlyze analyze stats.json
+  # or (if using npx)
+  npx packlyze analyze stats.json
+  ```
+4. **Output an HTML report to a custom location**:
+  ```bash
+  packlyze analyze stats.json -o ./reports/bundle-report.html
+  ```
+5. **Get results in JSON format (for CI/CD or automation):**
+  ```bash
+  packlyze analyze stats.json --json
+  ```
+
+### 2. Library Usage
+
+#### Step-by-step:
+1. **Install Packlyze** as a dependency:
+  ```bash
+  npm install packlyze
+  ```
+2. **Import and use in your code:**
+  ```typescript
+  import { Packlyze } from 'packlyze';
+
+  const analyzer = new Packlyze('./dist/stats.json');
+  const result = await analyzer.analyze();
+
+  console.log(result.recommendations);
+  console.log(result.metrics);
+  console.log(result.bundleStats.modules);
+  ```
 
 ## 📁 Project Structure
 
+Typical structure for a Packlyze-based project:
+
 ```
 Packlyze-plus/
 ├── src/
@@ -77,37 +107,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 +134,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 +144,8 @@ The analyzer provides:
 
 ## 📝 Examples
 
+Here are some example commands and configurations for different frameworks:
+
 ### Webpack Project
 
 ```bash
@@ -176,6 +184,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 +199,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 +228,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 +240,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.2",
   "description": "Advanced bundle analyzer with insights, recommendations, and historical tracking",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",