packlyze 1.0.1 → 1.0.2

package/README.md

@@ -28,47 +28,59 @@ npm install -g packlyze
 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
-
-# Analyze with packlyze
-packlyze analyze stats.json
-
-# Output HTML report to custom location
-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';
-
-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
 

package/package.json

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