Skip to content

Commit b7d80b2

Browse files
committed
updated readme
1 parent f01cf37 commit b7d80b2

File tree

2 files changed

+58
-6
lines changed

2 files changed

+58
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
1-
# NPG (Node Package Guard)
2-
3-
[![Test & Build](https://github.com/uscreen/npg/actions/workflows/docker.yml/badge.svg)](https://github.com/uscreen/npg/actions/workflows/docker.yml)
4-
[![Known Vulnerabilities](https://snyk.io/test/github/uscreen/npg/badge.svg)](https://snyk.io/test/github/uscreen/npg)
5-
[![codecov](https://codecov.io/gh/uscreen/npg/graph/badge.svg?token=0QK0kheO7v)](https://codecov.io/gh/uscreen/npg)
6-
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL_v3-blue)](https://opensource.org/license/agpl-v3)
1+
<p align="center">
2+
<img width="160" src="assets/npg-logo.svg" alt="NPG logo">
3+
</p>
4+
<p align="center"><b>open-source npm security gateway:</b><br> supply chain defense, faster CI, no dev install</p>
5+
<p align="center">
6+
<a href="https://github.com/uscreen/npg/actions/workflows/docker.yml">
7+
<img src="https://github.com/uscreen/npg/actions/workflows/docker.yml/badge.svg" alt="Test & Build">
8+
</a>
9+
<a href="https://snyk.io/test/github/uscreen/npg">
10+
<img src="https://snyk.io/test/github/uscreen/npg/badge.svg" alt="Known Vulnerabilities">
11+
</a>
12+
<a href="https://codecov.io/gh/uscreen/npg">
13+
<img src="https://codecov.io/gh/uscreen/npg/graph/badge.svg?token=0QK0kheO7v" alt="codecov">
14+
</a>
15+
<a href="https://opensource.org/license/agpl-v3">
16+
<img src="https://img.shields.io/badge/license-AGPL_v3-blue" alt="License: AGPL v3">
17+
</a>
18+
</p>
19+
20+
# NPG - Node Package Guard
721

822
A security-focused npm registry proxy that protects your development environment from malicious packages and supply chain attacks while providing high-performance caching.
923

24+
Deploy on your own infrastructure and point your npm/pnpm/yarn to it:
25+
26+
```bash
27+
echo "registry=https://npg.yourdomain.dev/npm/" >> ~/.npmrc
28+
```
29+
1030
## Security Features
1131

1232
- **Aikido Intel Integration** - Automatic blocking using [Aikido's open-source malware threat feed](https://intel.aikido.dev/?tab=malware)

assets/npg-logo.svg

Lines changed: 32 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)