pulp-image 0.1.0 → 0.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.
Files changed (2) hide show
  1. package/README.md +15 -38
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -18,45 +18,13 @@ A powerful, safety-first CLI tool for processing images with resize, format conv
18
18
 
19
19
  ## Installation
20
20
 
21
- ### From GitHub
22
-
23
- 1. **Clone or download the repository:**
24
- ```bash
25
- git clone https://github.com/rebelliongeeks/pulp-image.git
26
- cd pulp-image
27
- ```
28
-
29
- 2. **Install dependencies:**
30
- ```bash
31
- npm install
32
- ```
33
-
34
- 3. **Link the CLI globally:**
35
- ```bash
36
- npm link
37
- ```
38
-
39
- This will make the `pulp` command available globally on your system.
40
-
41
- ### Alternative: Install directly from GitHub
42
-
43
- You can also install directly from GitHub without cloning:
44
-
45
- ```bash
46
- npm install -g github:rebelliongeeks/pulp-image
47
- ```
48
-
49
- ### Global Installation (Persistent)
50
-
51
- If you want the `pulp` command to work even after deleting the project folder, use global installation instead of `npm link`:
21
+ Install pulp-image globally using npm:
52
22
 
53
23
  ```bash
54
- npm install -g .
24
+ npm install -g pulp-image
55
25
  ```
56
26
 
57
- This copies the files to your global npm directory, so the command persists even if you delete the source folder.
58
-
59
- **Note:** `npm link` creates a symlink (breaks if you delete the folder). `npm install -g` copies files (persists after deletion).
27
+ This will make the `pulp` command available globally on your system.
60
28
 
61
29
  ### Requirements
62
30
 
@@ -316,12 +284,21 @@ Example output:
316
284
  Total saved: 9.26 MB (92.03%)
317
285
  ```
318
286
 
319
- ## Interactive Documentation
287
+ ## Browser UI
320
288
 
321
- For a beautiful interactive documentation with examples, open:
289
+ pulp-image includes a web-based interface for easy image processing:
290
+
291
+ ```bash
292
+ pulp ui
322
293
  ```
323
- docs/index.html
294
+
295
+ This starts a local web server. Open your browser and navigate to:
296
+
324
297
  ```
298
+ http://localhost:3000
299
+ ```
300
+
301
+ The browser UI provides a user-friendly interface for processing images with all the same features available in the CLI.
325
302
 
326
303
  ## License
327
304
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pulp-image",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "A CLI tool for processing images with resize, format conversion, and optimization",
5
5
  "type": "module",
6
6
  "main": "bin/pulp.js",
@@ -19,6 +19,7 @@
19
19
  ],
20
20
  "author": "Rebellion Geeks",
21
21
  "license": "MIT",
22
+ "homepage": "https://github.com/rebelliongeeks/pulp-image",
22
23
  "repository": {
23
24
  "type": "git",
24
25
  "url": "https://github.com/rebelliongeeks/pulp-image.git"