update npm registry readme (#227)

* update npm registry readme

Signed-off-by: Sudhanshu Dasgupta <dasguptashivam23@gmail.com>

* fix command

Signed-off-by: Sudhanshu Dasgupta <dasguptashivam23@gmail.com>

---------

Signed-off-by: Sudhanshu Dasgupta <dasguptashivam23@gmail.com>
This commit is contained in:
Sudhanshu Dasgupta
2026-04-23 13:05:03 +00:00
committed by GitHub
parent c3a3518c36
commit 6099571411
+25 -19
View File
@@ -1,47 +1,50 @@
# PMG - Package Manager Guard
<div align="center">
<img src="https://raw.githubusercontent.com/safedep/pmg/main/docs/assets/pmg-banner.png" alt="PMG banner">
</div>
# Package Manager Guard (PMG)
🤖 PMG protects developers from getting compromised by malicious open source packages.
PMG intercepts package installs and checks them for malware before code executes. Install it once, and your usual package manager workflows can stay the same.
This is the npm distribution of PMG, a tool that wraps your favorite package manager (e.g., `npm`) and blocks malicious packages at install time.
This package is the npm distribution of PMG. The main project README at [`github.com/safedep/pmg`](https://github.com/safedep/pmg) is the source of truth for full documentation.
## Installation
## Why PMG?
Install PMG globally via npm:
- Protects developers and AI coding agents from malicious packages
- Wraps tools like `npm`, `pnpm`, `yarn`, `pip`, `poetry`, and `uv`
- Adds sandboxing and install-time security checks with minimal workflow changes
## Install
```bash
npm install -g @safedep/pmg
```
Or using Homebrew:
You can also install PMG with Homebrew:
```bash
brew tap safedep/tap
brew install safedep/tap/pmg
```
## Usage
## Quick Start
Set up PMG to automatically protect your package installations:
Set up PMG so your normal package manager commands are protected automatically:
```bash
# Recommended: Set up automatic protection
pmg setup install
```
After setup, use your package managers normally:
After setup, restart your terminal and keep using your tools as usual:
```bash
# Your regular commands are now protected
npm install express
pnpm add react
pip install requests
```
Or use PMG manually without setup:
If you prefer, you can also run package manager commands through PMG directly:
```bash
# Manual protection (alternative)
pmg npm install express
pmg pnpm add react
pmg pip install requests
@@ -49,12 +52,15 @@ pmg pip install requests
## Platform Support
- **macOS** (Intel & Apple Silicon)
- **Linux** (x86_64, ARM64, i386)
- **Windows** (x86_64, ARM64, i386)
- macOS
- Linux
- Windows
Requires Node.js 14 or higher.
---
## Learn More
For complete documentation, advanced usage, troubleshooting, and more information, please visit: **[github.com/safedep/pmg](https://github.com/safedep/pmg)**
For complete documentation, installation options, troubleshooting, and project updates, see:
- [Main README](https://github.com/safedep/pmg)
- [Quickstart Docs](https://docs.safedep.io/pmg/quickstart)