mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
docs: Update README (#133)
* docs: Update README * docs: Update README * docs: Update README * docs: Update README * docs: Update README * Apply suggestion from @Sahilb315 Co-authored-by: Sahil Bansal <bansalsahil315@gmail.com> Signed-off-by: Abhisek Datta <abhisek.datta@gmail.com> --------- Signed-off-by: Abhisek Datta <abhisek.datta@gmail.com> Co-authored-by: Sahil Bansal <bansalsahil315@gmail.com>
This commit is contained in:
co-authored by
Sahil Bansal
parent
736c63a7b6
commit
aa5c528a9d
@@ -1,8 +1,19 @@
|
|||||||
# Package Manager Guard (PMG)
|
<div align="center">
|
||||||
|
<img src="./docs/assets/pmg-github-banner.png" width="900" alt="PMG GitHub Banner">
|
||||||
|
</div>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<h1>Package Manager Guard (PMG)</h1>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<a href="https://docs.safedep.io/pmg/quickstart"><img src="https://img.shields.io/badge/Docs-docs.safedep.io-2b9246?style=for-the-badge&logo=gitbook&logoColor=white" alt="Docs"></a>
|
||||||
|
<a href="https://safedep.io"><img src="https://img.shields.io/badge/Website-safedep.io-3b82f6?style=for-the-badge&logoColor=white" alt="Website"></a>
|
||||||
|
|
||||||
|
<a href="https://discord.gg/kAGEj25dCn"><img src="https://img.shields.io/discord/1090352019379851304?style=for-the-badge&logo=discord&logoColor=white&color=5865F2" alt="Discord"></a>
|
||||||
|
|
||||||
<p>
|
|
||||||
Created and maintained by <b><a href="https://safedep.io/">https://safedep.io</a></b> with contributions from the community 🚀
|
|
||||||
</p>
|
|
||||||
|
|
||||||
[](https://goreportcard.com/report/github.com/safedep/pmg)
|
[](https://goreportcard.com/report/github.com/safedep/pmg)
|
||||||

|

|
||||||
@@ -10,8 +21,20 @@
|
|||||||
[](https://api.securityscorecards.dev/projects/github.com/safedep/pmg)
|
[](https://api.securityscorecards.dev/projects/github.com/safedep/pmg)
|
||||||
[](https://github.com/safedep/pmg/actions/workflows/codeql.yml)
|
[](https://github.com/safedep/pmg/actions/workflows/codeql.yml)
|
||||||
|
|
||||||
🤖 PMG protects developers from getting compromised by malicious packages.
|
</div>
|
||||||
See [example](https://safedep.io/malicious-npm-package-express-cookie-parser/)
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<h3>PMG protects developers from getting compromised by malicious packages.
|
||||||
|
See <a href="https://safedep.io/malicious-npm-package-express-cookie-parser/">example</a></h3>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<img src="./docs/demo/pmg-intro.gif" width="800" alt="pmg in action">
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
- Wraps your favorite package manager (eg. `npm`, `pnpm`, `pip` and more)
|
- Wraps your favorite package manager (eg. `npm`, `pnpm`, `pip` and more)
|
||||||
- Blocks malicious packages at install time
|
- Blocks malicious packages at install time
|
||||||
@@ -22,11 +45,7 @@ See [example](https://safedep.io/malicious-npm-package-express-cookie-parser/)
|
|||||||
PMG guarantees its own artifact integrity using GitHub and npm attestations. Users can cryptographically prove that the binary they run
|
PMG guarantees its own artifact integrity using GitHub and npm attestations. Users can cryptographically prove that the binary they run
|
||||||
matches the source code they reviewed, eliminating the risk of tampered or malicious builds. See [why and how to trust PMG](docs/trust.md).
|
matches the source code they reviewed, eliminating the risk of tampered or malicious builds. See [why and how to trust PMG](docs/trust.md).
|
||||||
|
|
||||||
## PMG in Action
|
## Quick Start
|
||||||
|
|
||||||
<img src="./docs/demo/pmg-intro.gif" width="800" alt="pmg in action">
|
|
||||||
|
|
||||||
## TL;DR
|
|
||||||
|
|
||||||
Install `pmg` using your favorite package manager:
|
Install `pmg` using your favorite package manager:
|
||||||
|
|
||||||
@@ -72,17 +91,17 @@ uv pip install <package-name>
|
|||||||
|
|
||||||
PMG supports the following package managers:
|
PMG supports the following package managers:
|
||||||
|
|
||||||
| Package Manager | Status | Command |
|
| Package Manager | Status | Command |
|
||||||
| --------------- | -------- | -------------------------------------------------------- |
|
| --------------- | ------ | -------------------------------------------------------- |
|
||||||
| `npm` | ✅ Active | `pmg npm install <package>` |
|
| `npm` | ✅ | `pmg npm install <package>` |
|
||||||
| `pnpm` | ✅ Active | `pmg pnpm add <package>` |
|
| `pnpm` | ✅ | `pmg pnpm add <package>` |
|
||||||
| `bun` | ✅ Active | `pmg bun add <package>` |
|
| `bun` | ✅ | `pmg bun add <package>` |
|
||||||
| `yarn` | ✅ Active | `pmg yarn add <package>` |
|
| `yarn` | ✅ | `pmg yarn add <package>` |
|
||||||
| `pip` | ✅ Active | `pmg pip install <package>` |
|
| `pip` | ✅ | `pmg pip install <package>` |
|
||||||
| `uv` | ✅ Active | `pmg uv add <package>` or `pmg uv pip install <package>` |
|
| `uv` | ✅ | `pmg uv add <package>` or `pmg uv pip install <package>` |
|
||||||
| `poetry` | ✅ Active | `pmg poetry add <package>` |
|
| `poetry` | ✅ | `pmg poetry add <package>` |
|
||||||
| `npx` | ✅ Active | `pmg npx <package> <action>` |
|
| `npx` | ✅ | `pmg npx <package> <action>` |
|
||||||
| `pnpx` | ✅ Active | `pmg pnpx <package> <action>` |
|
| `pnpx` | ✅ | `pmg pnpx <package> <action>` |
|
||||||
|
|
||||||
> Want us to support your favorite package manager? [Open an issue](https://github.com/safedep/pmg/issues) and let us know!
|
> Want us to support your favorite package manager? [Open an issue](https://github.com/safedep/pmg/issues) and let us know!
|
||||||
|
|
||||||
@@ -233,7 +252,7 @@ pmg npm install <package-name>
|
|||||||
## Advanced
|
## Advanced
|
||||||
|
|
||||||
- [Trusted Packages](docs/trusted-packages.md)
|
- [Trusted Packages](docs/trusted-packages.md)
|
||||||
- [Experimental Proxy Mode](docs/proxy-mode.md)
|
- [Proxy Mode](docs/proxy-mode.md)
|
||||||
- [Sandbox](docs/sandbox.md)
|
- [Sandbox](docs/sandbox.md)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 207 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 283 KiB After Width: | Height: | Size: 307 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 153 KiB After Width: | Height: | Size: 179 KiB |
+11
-11
@@ -23,14 +23,14 @@ experimental_proxy_mode: true
|
|||||||
|
|
||||||
## Supported Package Managers
|
## Supported Package Managers
|
||||||
|
|
||||||
| Package Manager | Status |
|
| Package Manager | Status |
|
||||||
| --------------- | --------- |
|
| --------------- | ------ |
|
||||||
| `npm` | ✅ Active |
|
| `npm` | ✅ |
|
||||||
| `npx` | ✅ Active |
|
| `npx` | ✅ |
|
||||||
| `pnpm` | ✅ Active |
|
| `pnpm` | ✅ |
|
||||||
| `pnpx` | ✅ Active |
|
| `pnpx` | ✅ |
|
||||||
| `bun` | ✅ Active |
|
| `bun` | ✅ |
|
||||||
| `yarn` | ✅ Active |
|
| `yarn` | ✅ |
|
||||||
| `pip` | 🕒 Planned |
|
| `pip` | 🕒 |
|
||||||
| `uv` | 🕒 Planned |
|
| `uv` | 🕒 |
|
||||||
| `poetry` | 🕒 Planned |
|
| `poetry` | 🕒 |
|
||||||
|
|||||||
Reference in New Issue
Block a user