feat: improvements

README.md

@@ -1,31 +1,37 @@
-# pnpmf
+<h1 align="center">PNPMF</h1>
 
-A dead simple pnpm group selector.
+<p align="center">
+  <img src="./example.png" alt="PNPMF Example">
+</p>
 
-## Usage
+A simple tool to run `pnpm` commands on selected groups of packages from your `pnpm-workspace.yaml`.
 
-```bash
-npm i -g pnpm
-```
+## Installation
 
-Then, in your `pnpm-workspace.yaml`:
-
-```yaml
-packages:
-  # ...
-
-# Define your groups as a list of valid pnpm filters
-groups:
-  MyGroup:
-    - package1
-    - package2
-  Test:
-    - @org/*-ui # Select all packages that match the pattern
-  Build:
-    - core... # any kind of pnpm filter syntax works!
-```
+1. Install `pnpm` globally:
+
+   ```bash
+   npm i -g pnpm
+   ```
+
+2. Define groups in your `pnpm-workspace.yaml`:
+
+   ```yaml
+   # ...
+
+   groups:
+     MyGroup:
+       - package1
+       - package2
+     Test:
+       - '@org/*-ui' # any kind of pattern supported by pnpm is allowed
+     Build:
+       - pkg-core... # use X... to match dependencies of X or ...X to match dependents of X
+   ```
+
+## Usage
 
-Then, you can replace you `pnpm` calls with `pnpmf` or `pf` to open a checkbox of groups to select from.
+Instead of running `pnpm`, use `pnpmf` (or the shortcut `pf`) to select groups interactively.
 
 ```bash
 # before
@@ -39,9 +45,24 @@ pf install
 # before
 pnpm --parallel build
 
+# after
 pf --parallel build
 ```
 
+### How it works
+
+1. When you run `pf`, it prompts you to select one or more groups.
+2. It then passes the selected packages as filters to `pnpm`.
+
+For example:
+
+```bash
+pf install # selects Test and MyGroup
+
+# Equivalent to:
+pnpm -F package1 -F package2 -F @org/*-ui install
+```
+
 ## License
 
-MIT
+MIT

package.json

@@ -5,8 +5,10 @@
     "type": "git",
     "url": "git+ssh://git@github.com/arthurfiorette/pnpmf.git"
   },
+  "funding": "https://github.com/arthurfiorette/pnpmf?sponsor=1",
   "license": "MIT",
   "author": "Arthur Fiorette <me@arthur.place>",
+  "sideEffects": false,
   "type": "module",
   "main": "./index.js",
   "bin": {